From 9d58740b62dfd887d55b1955ef9d612a5301ac55 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 19:42:43 -0500
Subject: [PATCH 01/31] Revert "fix(docs): fixes pipeline for Writerside"
This reverts commit 07b8af59051f72ae215e6f308a739fd5655be26b.
---
.github/workflows/build_docs.yml | 2 +-
Writerside/writerside-config.xml | 3 ---
2 files changed, 1 insertion(+), 4 deletions(-)
delete mode 100644 Writerside/writerside-config.xml
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index a03dbb2..b7292be 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -2,7 +2,7 @@ name: Build and Deploy Writerside Documentation
on:
push:
- branches: ['canary']
+ branches: ['main']
workflow_dispatch:
permissions:
diff --git a/Writerside/writerside-config.xml b/Writerside/writerside-config.xml
deleted file mode 100644
index d07aef0..0000000
--- a/Writerside/writerside-config.xml
+++ /dev/null
@@ -1,3 +0,0 @@
-
-
-
From 4e219790ad9154fd56fb3f278b23284b96af787e Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 19:52:01 -0500
Subject: [PATCH 02/31] fix(docs): fixes pipeline for Writerside
---
.github/workflows/build_docs.yml | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index b7292be..f505837 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -2,8 +2,8 @@ name: Build and Deploy Writerside Documentation
on:
push:
- branches: ['main']
- workflow_dispatch:
+ branches: ['main'] # Trigger the workflow when changes are pushed to the 'main' branch
+ workflow_dispatch: # Allow manual triggering of the workflow
permissions:
id-token: write
@@ -30,8 +30,7 @@ jobs:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}
- # Update to reflect the path of your Writerside directory inside the app
- path: Writerside
+ path: Writerside # Specify the directory for Writerside docs
- name: Upload artifact
uses: actions/upload-artifact@v4
@@ -44,7 +43,6 @@ jobs:
deploy:
environment:
name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
@@ -68,3 +66,6 @@ jobs:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4.0.4
+
+ - name: Print GitHub Pages URL
+ run: echo "Your site is deployed at ${{ steps.deployment.outputs.page_url }}"
From c9535e974f040dd8f47f6f4742411f0198745df9 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 19:52:01 -0500
Subject: [PATCH 03/31] fix(docs): adds GH_TOKEN
---
.github/workflows/build_docs.yml | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index b7292be..e1b9a84 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -2,8 +2,8 @@ name: Build and Deploy Writerside Documentation
on:
push:
- branches: ['main']
- workflow_dispatch:
+ branches: ['main'] # Trigger the workflow when changes are pushed to the 'main' branch
+ workflow_dispatch: # Allow manual triggering of the workflow
permissions:
id-token: write
@@ -22,6 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
+ token: ${{ secrets.GH_TOKEN }}
fetch-depth: 0
- name: Build Writerside docs using Docker
@@ -30,8 +31,7 @@ jobs:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}
- # Update to reflect the path of your Writerside directory inside the app
- path: Writerside
+ path: Writerside # Specify the directory for Writerside docs
- name: Upload artifact
uses: actions/upload-artifact@v4
@@ -44,7 +44,6 @@ jobs:
deploy:
environment:
name: github-pages
- url: ${{ steps.deployment.outputs.page_url }}
needs: build
runs-on: ubuntu-latest
@@ -68,3 +67,6 @@ jobs:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4.0.4
+
+ - name: Print GitHub Pages URL
+ run: echo "Your site is deployed at ${{ steps.deployment.outputs.page_url }}"
From 60ae8e7a86aaeb78b8834ce3107038df3021a8b0 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:04:31 -0500
Subject: [PATCH 04/31] Update build_docs.yml
---
.github/workflows/build_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index e1b9a84..04d963a 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -22,7 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GH_TOKEN }}
+ token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0
- name: Build Writerside docs using Docker
From 802f062aee2679c47d3739e0a7c88c4493b64246 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:13:01 -0500
Subject: [PATCH 05/31] fix(docs): github actions
---
.github/workflows/build_docs.yml | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index e1b9a84..f83f74c 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -2,16 +2,16 @@ name: Build and Deploy Writerside Documentation
on:
push:
- branches: ['main'] # Trigger the workflow when changes are pushed to the 'main' branch
- workflow_dispatch: # Allow manual triggering of the workflow
+ branches: ["main"] # Trigger the workflow when changes are pushed to the 'main' branch
+ workflow_dispatch: # Allow manual triggering of the workflow
permissions:
id-token: write
pages: write
env:
- INSTANCE: Writerside/Kurocado Studio Styleguide # Adjust the instance based on your configuration
- ARTIFACT: webHelpKSS2-all.zip # Adjust if needed
+ INSTANCE: Writerside/Kurocado Studio Styleguide
+ ARTIFACT: webHelpKSS2-all.zip
DOCKER_VERSION: 242.21870
jobs:
@@ -22,7 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GH_TOKEN }}
+ token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT)
fetch-depth: 0
- name: Build Writerside docs using Docker
@@ -31,7 +31,7 @@ jobs:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}
- path: Writerside # Specify the directory for Writerside docs
+ path: Writerside # Specify the directory for Writerside docs
- name: Upload artifact
uses: actions/upload-artifact@v4
From f8df1761b2a9a89a4a338e2225364101546ce59b Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:18:22 -0500
Subject: [PATCH 06/31] fix(docs): changes path for location in Writerside
config
---
.github/workflows/build_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index f83f74c..87f9383 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -31,7 +31,7 @@ jobs:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}
- path: Writerside # Specify the directory for Writerside docs
+ location: Writerside # Specify the directory for Writerside docs
- name: Upload artifact
uses: actions/upload-artifact@v4
From 7ddff082c71f1b46ffb075aaba6352805bd59ded Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:19:27 -0500
Subject: [PATCH 07/31] fix(docs): changes docker version
---
.github/workflows/build_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 87f9383..533d6d3 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -12,7 +12,7 @@ permissions:
env:
INSTANCE: Writerside/Kurocado Studio Styleguide
ARTIFACT: webHelpKSS2-all.zip
- DOCKER_VERSION: 242.21870
+ DOCKER_VERSION: latest
jobs:
build:
From 788b9f6f5092ab5241ab9c42faa70f7e58198bcc Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:19:27 -0500
Subject: [PATCH 08/31] fix(docs): changes docker version
---
.github/workflows/build_docs.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 87f9383..76ec12a 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -11,8 +11,8 @@ permissions:
env:
INSTANCE: Writerside/Kurocado Studio Styleguide
- ARTIFACT: webHelpKSS2-all.zip
- DOCKER_VERSION: 242.21870
+ ARTIFACT: webHelpkssS2-all.zip
+ DOCKER_VERSION: 242.2187
jobs:
build:
From db3629cc2054c81e1fc32085472c5a9812a32b84 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:33:51 -0500
Subject: [PATCH 09/31] fix(docs): changes docker version
---
.github/workflows/build_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 76ec12a..db83059 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -12,7 +12,7 @@ permissions:
env:
INSTANCE: Writerside/Kurocado Studio Styleguide
ARTIFACT: webHelpkssS2-all.zip
- DOCKER_VERSION: 242.2187
+ DOCKER_VERSION: 242.21870
jobs:
build:
From 4960c7225d94371cfdd0f27a094003e19f6dfbf6 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:39:32 -0500
Subject: [PATCH 10/31] fix(docs): docker pull
registry.jetbrains.team/p/writerside & changes docker version
---
.github/workflows/build_docs.yml | 3 +++
1 file changed, 3 insertions(+)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index db83059..8d555b0 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -25,6 +25,9 @@ jobs:
token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT)
fetch-depth: 0
+ - name: Pull Writerside Docker image # Add this step to explicitly pull the Docker image
+ run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
+
- name: Build Writerside docs using Docker
uses: JetBrains/writerside-github-action@v4
with:
From b37dc6b5962caee292b654b344eb4d97ac9f0865 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:41:10 -0500
Subject: [PATCH 11/31] fix(docs): webHelpKSS2-all.zip
---
.github/workflows/build_docs.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 8d555b0..2c76c47 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -11,8 +11,8 @@ permissions:
env:
INSTANCE: Writerside/Kurocado Studio Styleguide
- ARTIFACT: webHelpkssS2-all.zip
- DOCKER_VERSION: 242.21870
+ ARTIFACT: webHelpKSS2-all.zip
+ DOCKER_VERSION: 242.2187
jobs:
build:
From 638059aee2032306196acfa1489b29fa3709415d Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:42:11 -0500
Subject: [PATCH 12/31] fix(docs): changes DOCKER_VERSION to latest
---
.github/workflows/build_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 2c76c47..3e2ff7d 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -12,7 +12,7 @@ permissions:
env:
INSTANCE: Writerside/Kurocado Studio Styleguide
ARTIFACT: webHelpKSS2-all.zip
- DOCKER_VERSION: 242.2187
+ DOCKER_VERSION: latest
jobs:
build:
From 68a0f04ab9b685b0ee8010830cd5cb4fd2b8fa43 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:49:37 -0500
Subject: [PATCH 13/31] fix(docs): changes DOCKER_VERSION to latest again
---
.github/workflows/build_docs.yml | 54 +++++++++-----------------------
1 file changed, 15 insertions(+), 39 deletions(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 3e2ff7d..443da58 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -1,23 +1,18 @@
-name: Build and Deploy Writerside Documentation
+name: Build documentation
on:
push:
- branches: ["main"] # Trigger the workflow when changes are pushed to the 'main' branch
- workflow_dispatch: # Allow manual triggering of the workflow
-
-permissions:
- id-token: write
- pages: write
+ branches: ['main']
+ workflow_dispatch:
env:
- INSTANCE: Writerside/Kurocado Studio Styleguide
- ARTIFACT: webHelpKSS2-all.zip
- DOCKER_VERSION: latest
+ INSTANCE: 'Writerside/Kurocado Studio Styleguide'
+ ARTIFACT: 'webHelpKSS2-all.zip'
+ DOCKER_VERSION: '242.21870'
jobs:
build:
runs-on: ubuntu-latest
-
steps:
- name: Checkout repository
uses: actions/checkout@v4
@@ -25,51 +20,32 @@ jobs:
token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT)
fetch-depth: 0
- - name: Pull Writerside Docker image # Add this step to explicitly pull the Docker image
- run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
-
- - name: Build Writerside docs using Docker
+ - name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}
- location: Writerside # Specify the directory for Writerside docs
- - name: Upload artifact
+ - name: Save artifact with build results
uses: actions/upload-artifact@v4
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }}
+ artifacts/report.json
retention-days: 7
-
- deploy:
- environment:
- name: github-pages
+ test:
needs: build
runs-on: ubuntu-latest
-
steps:
- - name: Download artifact
+ - name: Download artifacts
uses: actions/download-artifact@v4
with:
name: docs
+ path: artifacts
- - name: Unzip artifact
- run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
-
- - name: Setup Pages
- uses: actions/configure-pages@v4.0.0
-
- - name: Upload artifact
- uses: actions/upload-pages-artifact@v3.0.1
+ - name: Test documentation
+ uses: JetBrains/writerside-checker-action@v1
with:
- path: dir
-
- - name: Deploy to GitHub Pages
- id: deployment
- uses: actions/deploy-pages@v4.0.4
-
- - name: Print GitHub Pages URL
- run: echo "Your site is deployed at ${{ steps.deployment.outputs.page_url }}"
+ instance: ${{ env.INSTANCE }}
From facde29f793295c0763989677d008e71fc03a945 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:55:32 -0500
Subject: [PATCH 14/31] fix(docs): adds writerside-config.xml
---
Writerside/writerside-config.xml | 5 +++++
1 file changed, 5 insertions(+)
create mode 100644 Writerside/writerside-config.xml
diff --git a/Writerside/writerside-config.xml b/Writerside/writerside-config.xml
new file mode 100644
index 0000000..e15c9fb
--- /dev/null
+++ b/Writerside/writerside-config.xml
@@ -0,0 +1,5 @@
+
+
+
+
+
From 26cbc9273f17dac3b3ef09302de1917d9c6b67d1 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 20:58:16 -0500
Subject: [PATCH 15/31] fix(docs): renames path to
Writerside/kurocado-studio-styleguide
---
.github/workflows/build_docs.yml | 2 +-
Writerside/kss.tree | 4 ++--
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
index 443da58..ad018bd 100644
--- a/.github/workflows/build_docs.yml
+++ b/.github/workflows/build_docs.yml
@@ -6,7 +6,7 @@ on:
workflow_dispatch:
env:
- INSTANCE: 'Writerside/Kurocado Studio Styleguide'
+ INSTANCE: 'Writerside/kurocado-studio-styleguide'
ARTIFACT: 'webHelpKSS2-all.zip'
DOCKER_VERSION: '242.21870'
diff --git a/Writerside/kss.tree b/Writerside/kss.tree
index bf9793b..10f0e30 100644
--- a/Writerside/kss.tree
+++ b/Writerside/kss.tree
@@ -3,8 +3,8 @@
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
-
\ No newline at end of file
+
From 5dd504fbac617ab142291c45de45f2adcb2ea511 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:01:20 -0500
Subject: [PATCH 16/31] fix(docs): renames path to
Writerside/kurocado-studio-styleguide
---
Writerside/writerside-config.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Writerside/writerside-config.xml b/Writerside/writerside-config.xml
index e15c9fb..2060a86 100644
--- a/Writerside/writerside-config.xml
+++ b/Writerside/writerside-config.xml
@@ -1,5 +1,5 @@
-
+
From a81306f85e45e7b27b839797c40a6f4c588fea36 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:06:26 -0500
Subject: [PATCH 17/31] fix(docs): renames path to
Writerside/kurocado-studio-styleguide /kss.tree
---
Writerside/writerside-config.xml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Writerside/writerside-config.xml b/Writerside/writerside-config.xml
index 2060a86..4ae9df8 100644
--- a/Writerside/writerside-config.xml
+++ b/Writerside/writerside-config.xml
@@ -1,5 +1,5 @@
-
+
From 9f3c01c3fb3764b08e4b4a35d96fb7053a1ffea3 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:17:44 -0500
Subject: [PATCH 18/31] fix(docs): restructures Writerside/docs
---
.github/workflows/build_docs.yml | 51 ----------------------
.github/workflows/deploy_docs.yml | 71 +++++++++++++++++++++++++++++++
Writerside/cfg/buildprofiles.xml | 2 +-
Writerside/{kss.tree => dcs.tree} | 6 +--
Writerside/redirection-rules.xml | 17 --------
5 files changed, 75 insertions(+), 72 deletions(-)
delete mode 100644 .github/workflows/build_docs.yml
create mode 100644 .github/workflows/deploy_docs.yml
rename Writerside/{kss.tree => dcs.tree} (71%)
delete mode 100644 Writerside/redirection-rules.xml
diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
deleted file mode 100644
index ad018bd..0000000
--- a/.github/workflows/build_docs.yml
+++ /dev/null
@@ -1,51 +0,0 @@
-name: Build documentation
-
-on:
- push:
- branches: ['main']
- workflow_dispatch:
-
-env:
- INSTANCE: 'Writerside/kurocado-studio-styleguide'
- ARTIFACT: 'webHelpKSS2-all.zip'
- DOCKER_VERSION: '242.21870'
-
-jobs:
- build:
- runs-on: ubuntu-latest
- steps:
- - name: Checkout repository
- uses: actions/checkout@v4
- with:
- token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT)
- fetch-depth: 0
-
- - name: Build docs using Writerside Docker builder
- uses: JetBrains/writerside-github-action@v4
- with:
- instance: ${{ env.INSTANCE }}
- artifact: ${{ env.ARTIFACT }}
- docker-version: ${{ env.DOCKER_VERSION }}
-
- - name: Save artifact with build results
- uses: actions/upload-artifact@v4
- with:
- name: docs
- path: |
- artifacts/${{ env.ARTIFACT }}
- artifacts/report.json
- retention-days: 7
- test:
- needs: build
- runs-on: ubuntu-latest
- steps:
- - name: Download artifacts
- uses: actions/download-artifact@v4
- with:
- name: docs
- path: artifacts
-
- - name: Test documentation
- uses: JetBrains/writerside-checker-action@v1
- with:
- instance: ${{ env.INSTANCE }}
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
new file mode 100644
index 0000000..4f65f7c
--- /dev/null
+++ b/.github/workflows/deploy_docs.yml
@@ -0,0 +1,71 @@
+name: Build and Deploy Writerside Documentation
+
+on:
+ push:
+ branches: ['main'] # Trigger the workflow on push to the main branch
+ workflow_dispatch: # Allow manual triggering of the workflow
+
+permissions:
+ id-token: write
+ pages: write
+
+env:
+ INSTANCE: Writerside/docs # Set the instance to 'docs' for easier reuse
+ ARTIFACT: webHelpDocs-all.zip # Adjust artifact name to reflect 'docs'
+ DOCKER_VERSION: 242.21870 # Correct Docker version as per Writerside setup
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v4
+ with:
+ fetch-depth: 0
+
+ - name: Pull Writerside Docker image
+ run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
+
+ - name: Build Writerside Documentation
+ uses: JetBrains/writerside-github-action@v4
+ with:
+ instance: ${{ env.INSTANCE }}
+ artifact: ${{ env.ARTIFACT }}
+ docker-version: ${{ env.DOCKER_VERSION }}
+
+ - name: Upload artifact for deployment
+ uses: actions/upload-artifact@v4
+ with:
+ name: docs
+ path: |
+ artifacts/${{ env.ARTIFACT }}
+ retention-days: 7
+
+ deploy:
+ runs-on: ubuntu-latest
+ needs: build
+
+ permissions:
+ pages: write # Permissions to publish to GitHub Pages
+ id-token: write
+
+ steps:
+ - name: Download artifact for deployment
+ uses: actions/download-artifact@v4
+ with:
+ name: docs
+
+ - name: Unzip artifact
+ run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+ - name: Configure GitHub Pages
+ uses: actions/configure-pages@v4
+
+ - name: Upload artifact to GitHub Pages
+ uses: actions/upload-pages-artifact@v3
+ with:
+ path: dir
+
+ - name: Deploy to GitHub Pages
+ uses: actions/deploy-pages@v4
diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml
index 85ea433..9d953bb 100644
--- a/Writerside/cfg/buildprofiles.xml
+++ b/Writerside/cfg/buildprofiles.xml
@@ -4,7 +4,7 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
-
+
false
diff --git a/Writerside/kss.tree b/Writerside/dcs.tree
similarity index 71%
rename from Writerside/kss.tree
rename to Writerside/dcs.tree
index 10f0e30..b34f765 100644
--- a/Writerside/kss.tree
+++ b/Writerside/dcs.tree
@@ -2,9 +2,9 @@
-
-
+
\ No newline at end of file
diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml
deleted file mode 100644
index 988d0fa..0000000
--- a/Writerside/redirection-rules.xml
+++ /dev/null
@@ -1,17 +0,0 @@
-
-
-
-
-
- Created after removal of "How to" from Kurocado Studio Styleguide
- How-to.html
-
-
- Created after removal of "Tutorial" from Kurocado Studio Styleguide
- Tutorial.html
-
-
From d84cc9d52c4302de0bd890e1687c165ab4b43511 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:19:24 -0500
Subject: [PATCH 19/31] fix(docs): adds secrets.GITHUB_TOKEN
---
.github/workflows/deploy_docs.yml | 1 +
Writerside/topics/starter-topic.md | 2 +-
Writerside/writerside-config.xml | 2 +-
Writerside/writerside.cfg | 2 +-
4 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index 4f65f7c..78b7f10 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -22,6 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
+ token: ${{ secrets.GITHUB_TOKEN }} # Use GITHUB_TOKEN for authentication
fetch-depth: 0
- name: Pull Writerside Docker image
diff --git a/Writerside/topics/starter-topic.md b/Writerside/topics/starter-topic.md
index 10488d5..2437067 100644
--- a/Writerside/topics/starter-topic.md
+++ b/Writerside/topics/starter-topic.md
@@ -1,4 +1,4 @@
-# About Kurocado Studio Styleguide
+# About docs
diff --git a/Writerside/writerside-config.xml b/Writerside/writerside-config.xml
index 4ae9df8..38b8c11 100644
--- a/Writerside/writerside-config.xml
+++ b/Writerside/writerside-config.xml
@@ -1,5 +1,5 @@
-
+
diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg
index 2b59f56..2f58de1 100644
--- a/Writerside/writerside.cfg
+++ b/Writerside/writerside.cfg
@@ -4,5 +4,5 @@
-
+
From d55b64920dfd6480cb622926ecceca187c9c85fe Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:19:24 -0500
Subject: [PATCH 20/31] fix(docs): adds secrets.GITHUB_TOKEN
---
.github/workflows/deploy_docs.yml | 5 +++--
Writerside/topics/starter-topic.md | 2 +-
Writerside/writerside-config.xml | 2 +-
Writerside/writerside.cfg | 2 +-
4 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index 4f65f7c..dc1ab5f 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -10,8 +10,8 @@ permissions:
pages: write
env:
- INSTANCE: Writerside/docs # Set the instance to 'docs' for easier reuse
- ARTIFACT: webHelpDocs-all.zip # Adjust artifact name to reflect 'docs'
+ INSTANCE: Writerside/docs # Adjust instance to reflect Writerside module and product
+ ARTIFACT: webHelpDocs-all.zip # Adjust artifact name if needed
DOCKER_VERSION: 242.21870 # Correct Docker version as per Writerside setup
jobs:
@@ -22,6 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
+ token: ${{ secrets.GITHUB_TOKEN }} # Use GITHUB_TOKEN for authentication
fetch-depth: 0
- name: Pull Writerside Docker image
diff --git a/Writerside/topics/starter-topic.md b/Writerside/topics/starter-topic.md
index 10488d5..2437067 100644
--- a/Writerside/topics/starter-topic.md
+++ b/Writerside/topics/starter-topic.md
@@ -1,4 +1,4 @@
-# About Kurocado Studio Styleguide
+# About docs
diff --git a/Writerside/writerside-config.xml b/Writerside/writerside-config.xml
index 4ae9df8..38b8c11 100644
--- a/Writerside/writerside-config.xml
+++ b/Writerside/writerside-config.xml
@@ -1,5 +1,5 @@
-
+
diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg
index 2b59f56..2f58de1 100644
--- a/Writerside/writerside.cfg
+++ b/Writerside/writerside.cfg
@@ -4,5 +4,5 @@
-
+
From d97901f95652b0474eac3039ed8c7dceb149e1df Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:23:14 -0500
Subject: [PATCH 21/31] fix(docs): updates file
---
.github/workflows/deploy_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index dc1ab5f..c4830d4 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -22,7 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GITHUB_TOKEN }} # Use GITHUB_TOKEN for authentication
+ token: ${{ secrets.GITHUB_TOKEN }} # Use GITHUB_TOKEN to access private repo
fetch-depth: 0
- name: Pull Writerside Docker image
From 97abdca3e55027fcb7bf0442b10b9ee91a89f0ed Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:27:49 -0500
Subject: [PATCH 22/31] fix(docs): adds back GH_TOKEN
---
.github/workflows/deploy_docs.yml | 45 +++++++++++++++----------------
1 file changed, 22 insertions(+), 23 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index c4830d4..4d67d7b 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -2,7 +2,7 @@ name: Build and Deploy Writerside Documentation
on:
push:
- branches: ['main'] # Trigger the workflow on push to the main branch
+ branches: ['main'] # Trigger the workflow when changes are pushed to the 'main' branch
workflow_dispatch: # Allow manual triggering of the workflow
permissions:
@@ -10,9 +10,9 @@ permissions:
pages: write
env:
- INSTANCE: Writerside/docs # Adjust instance to reflect Writerside module and product
- ARTIFACT: webHelpDocs-all.zip # Adjust artifact name if needed
- DOCKER_VERSION: 242.21870 # Correct Docker version as per Writerside setup
+ INSTANCE: Writerside/docs # This references the module name
+ ARTIFACT: webHelpDocs-all.zip # Adjust artifact name if necessary
+ DOCKER_VERSION: 242.21870
jobs:
build:
@@ -22,20 +22,17 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GITHUB_TOKEN }} # Use GITHUB_TOKEN to access private repo
+ token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT) or GITHUB_TOKEN for authentication
fetch-depth: 0
- name: Pull Writerside Docker image
run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
- - name: Build Writerside Documentation
- uses: JetBrains/writerside-github-action@v4
- with:
- instance: ${{ env.INSTANCE }}
- artifact: ${{ env.ARTIFACT }}
- docker-version: ${{ env.DOCKER_VERSION }}
+ - name: Build Writerside docs using Docker
+ run: |
+ /opt/builder/bin/idea.sh helpbuilderinspect -source-dir /github/workspace/Writerside -product kuro-cado-studio-styleguide
- - name: Upload artifact for deployment
+ - name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: docs
@@ -44,15 +41,13 @@ jobs:
retention-days: 7
deploy:
- runs-on: ubuntu-latest
+ environment:
+ name: github-pages
needs: build
-
- permissions:
- pages: write # Permissions to publish to GitHub Pages
- id-token: write
+ runs-on: ubuntu-latest
steps:
- - name: Download artifact for deployment
+ - name: Download artifact
uses: actions/download-artifact@v4
with:
name: docs
@@ -60,13 +55,17 @@ jobs:
- name: Unzip artifact
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
- - name: Configure GitHub Pages
- uses: actions/configure-pages@v4
+ - name: Setup Pages
+ uses: actions/configure-pages@v4.0.0
- - name: Upload artifact to GitHub Pages
- uses: actions/upload-pages-artifact@v3
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v3.0.1
with:
path: dir
- name: Deploy to GitHub Pages
- uses: actions/deploy-pages@v4
+ id: deployment
+ uses: actions/deploy-pages@v4.0.4
+
+ - name: Print GitHub Pages URL
+ run: echo "Your site is deployed at ${{ steps.deployment.outputs.page_url }}"
From ac2692f34dbbe468a6d031be9a46ff9e217b0624 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:31:39 -0500
Subject: [PATCH 23/31] fix(docs): build Writerside Documentation
---
.github/workflows/deploy_docs.yml | 11 +++++++----
1 file changed, 7 insertions(+), 4 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index 4d67d7b..0bc365f 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -28,11 +28,14 @@ jobs:
- name: Pull Writerside Docker image
run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
- - name: Build Writerside docs using Docker
- run: |
- /opt/builder/bin/idea.sh helpbuilderinspect -source-dir /github/workspace/Writerside -product kuro-cado-studio-styleguide
+ - name: Build Writerside Documentation
+ uses: JetBrains/writerside-github-action@v4
+ with:
+ instance: ${{ env.INSTANCE }}
+ artifact: ${{ env.ARTIFACT }}
+ docker-version: ${{ env.DOCKER_VERSION }}
- - name: Upload artifact
+ - name: Upload artifact for deployment
uses: actions/upload-artifact@v4
with:
name: docs
From 8aa13feea789d9b504483c88103cc4375a2c3382 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:34:47 -0500
Subject: [PATCH 24/31] fix(docs): build Writerside Documentation
---
.github/workflows/deploy_docs.yml | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index 0bc365f..a2df660 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -25,10 +25,7 @@ jobs:
token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT) or GITHUB_TOKEN for authentication
fetch-depth: 0
- - name: Pull Writerside Docker image
- run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
-
- - name: Build Writerside Documentation
+ - name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
From 59aae3fc89bb499dd6e5131da726d686243d1dd1 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:36:56 -0500
Subject: [PATCH 25/31] fix(docs): webHelpDocs2-all.zip
---
.github/workflows/deploy_docs.yml | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index a2df660..47f3878 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -11,7 +11,7 @@ permissions:
env:
INSTANCE: Writerside/docs # This references the module name
- ARTIFACT: webHelpDocs-all.zip # Adjust artifact name if necessary
+ ARTIFACT: webHelpDocs2-all.zip # Adjust artifact name if necessary
DOCKER_VERSION: 242.21870
jobs:
@@ -25,14 +25,14 @@ jobs:
token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT) or GITHUB_TOKEN for authentication
fetch-depth: 0
- - name: Build docs using Writerside Docker builder
- uses: JetBrains/writerside-github-action@v4
- with:
- instance: ${{ env.INSTANCE }}
- artifact: ${{ env.ARTIFACT }}
- docker-version: ${{ env.DOCKER_VERSION }}
+ - name: Pull Writerside Docker image
+ run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
+
+ - name: Build Writerside docs using Docker
+ run: |
+ /opt/builder/bin/idea.sh helpbuilderinspect -source-dir /github/workspace/Writerside -product docs
- - name: Upload artifact for deployment
+ - name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: docs
From 4d490d92d493c9bb4e6da06e7cc8cd1abcd2e4a6 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:38:06 -0500
Subject: [PATCH 26/31] fix(docs): webHelpDocs2-all.zip
---
.github/workflows/deploy_docs.yml | 44 +++++++++++++++----------------
1 file changed, 22 insertions(+), 22 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index 47f3878..ab97305 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -2,7 +2,7 @@ name: Build and Deploy Writerside Documentation
on:
push:
- branches: ['main'] # Trigger the workflow when changes are pushed to the 'main' branch
+ branches: ['main'] # Trigger the workflow on push to the main branch
workflow_dispatch: # Allow manual triggering of the workflow
permissions:
@@ -10,9 +10,9 @@ permissions:
pages: write
env:
- INSTANCE: Writerside/docs # This references the module name
- ARTIFACT: webHelpDocs2-all.zip # Adjust artifact name if necessary
- DOCKER_VERSION: 242.21870
+ INSTANCE: Writerside/docs # Adjust instance to reflect Writerside module and product
+ ARTIFACT: webHelpDocs-all.zip # Adjust artifact name if needed
+ DOCKER_VERSION: 242.21870 # Correct Docker version as per Writerside setup
jobs:
build:
@@ -22,17 +22,19 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT) or GITHUB_TOKEN for authentication
fetch-depth: 0
- name: Pull Writerside Docker image
run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
- - name: Build Writerside docs using Docker
- run: |
- /opt/builder/bin/idea.sh helpbuilderinspect -source-dir /github/workspace/Writerside -product docs
+ - name: Build Writerside Documentation
+ uses: JetBrains/writerside-github-action@v4
+ with:
+ instance: ${{ env.INSTANCE }}
+ artifact: ${{ env.ARTIFACT }}
+ docker-version: ${{ env.DOCKER_VERSION }}
- - name: Upload artifact
+ - name: Upload artifact for deployment
uses: actions/upload-artifact@v4
with:
name: docs
@@ -41,13 +43,15 @@ jobs:
retention-days: 7
deploy:
- environment:
- name: github-pages
- needs: build
runs-on: ubuntu-latest
+ needs: build
+
+ permissions:
+ pages: write # Permissions to publish to GitHub Pages
+ id-token: write
steps:
- - name: Download artifact
+ - name: Download artifact for deployment
uses: actions/download-artifact@v4
with:
name: docs
@@ -55,17 +59,13 @@ jobs:
- name: Unzip artifact
run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
- - name: Setup Pages
- uses: actions/configure-pages@v4.0.0
+ - name: Configure GitHub Pages
+ uses: actions/configure-pages@v4
- - name: Upload artifact
- uses: actions/upload-pages-artifact@v3.0.1
+ - name: Upload artifact to GitHub Pages
+ uses: actions/upload-pages-artifact@v3
with:
path: dir
- name: Deploy to GitHub Pages
- id: deployment
- uses: actions/deploy-pages@v4.0.4
-
- - name: Print GitHub Pages URL
- run: echo "Your site is deployed at ${{ steps.deployment.outputs.page_url }}"
+ uses: actions/deploy-pages@v4
From f504b27bf569e94e8fca49083ba29d7eb7eb2010 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:39:26 -0500
Subject: [PATCH 27/31] fix(docs): adds back secrets.GH_TOKEN
---
.github/workflows/deploy_docs.yml | 1 +
1 file changed, 1 insertion(+)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index ab97305..b28e551 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -22,6 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
+ token: ${{ secrets.GH_TOKEN }}
fetch-depth: 0
- name: Pull Writerside Docker image
From a3797b8e73362c24088ad4bd475366cb98b9ec91 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:41:22 -0500
Subject: [PATCH 28/31] fix(docs): adds back secrets.GITHUB_TOKEN
---
.github/workflows/deploy_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index b28e551..90813d3 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -22,7 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GH_TOKEN }}
+ token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0
- name: Pull Writerside Docker image
From 4acde692752fa21bbed03aa513200b08c2cce8d2 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:42:06 -0500
Subject: [PATCH 29/31] fix(docs): adds back secrets.GH_TOKEN
---
.github/workflows/deploy_docs.yml | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index 90813d3..b28e551 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -22,7 +22,7 @@ jobs:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GITHUB_TOKEN }}
+ token: ${{ secrets.GH_TOKEN }}
fetch-depth: 0
- name: Pull Writerside Docker image
From 2e2dabaf5335bffb53546fcfe1d0ee6565228983 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:43:54 -0500
Subject: [PATCH 30/31] fix(docs): writerside/docs
---
.github/workflows/deploy_docs.yml | 54 ++++++-------------------------
1 file changed, 9 insertions(+), 45 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index b28e551..a4cc5b4 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -1,72 +1,36 @@
-name: Build and Deploy Writerside Documentation
+name: Build documentation
on:
push:
- branches: ['main'] # Trigger the workflow on push to the main branch
- workflow_dispatch: # Allow manual triggering of the workflow
-
-permissions:
- id-token: write
- pages: write
+ branches: ['main']
+ workflow_dispatch:
env:
- INSTANCE: Writerside/docs # Adjust instance to reflect Writerside module and product
- ARTIFACT: webHelpDocs-all.zip # Adjust artifact name if needed
- DOCKER_VERSION: 242.21870 # Correct Docker version as per Writerside setup
+ INSTANCE: 'Writerside/docs'
+ ARTIFACT: 'webHelpDocs2-all.zip'
+ DOCKER_VERSION: '242.21870'
jobs:
build:
runs-on: ubuntu-latest
-
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
- token: ${{ secrets.GH_TOKEN }}
+ token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0
- - name: Pull Writerside Docker image
- run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
-
- - name: Build Writerside Documentation
+ - name: Build docs using Writerside Docker builder
uses: JetBrains/writerside-github-action@v4
with:
instance: ${{ env.INSTANCE }}
artifact: ${{ env.ARTIFACT }}
docker-version: ${{ env.DOCKER_VERSION }}
- - name: Upload artifact for deployment
+ - name: Save artifact with build results
uses: actions/upload-artifact@v4
with:
name: docs
path: |
artifacts/${{ env.ARTIFACT }}
retention-days: 7
-
- deploy:
- runs-on: ubuntu-latest
- needs: build
-
- permissions:
- pages: write # Permissions to publish to GitHub Pages
- id-token: write
-
- steps:
- - name: Download artifact for deployment
- uses: actions/download-artifact@v4
- with:
- name: docs
-
- - name: Unzip artifact
- run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
-
- - name: Configure GitHub Pages
- uses: actions/configure-pages@v4
-
- - name: Upload artifact to GitHub Pages
- uses: actions/upload-pages-artifact@v3
- with:
- path: dir
-
- - name: Deploy to GitHub Pages
- uses: actions/deploy-pages@v4
From d74f451b6575cd4a7ee614cc5c0bef13c08922b3 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:46:15 -0500
Subject: [PATCH 31/31] fix(docs): writerside/dcs
---
.github/workflows/deploy_docs.yml | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
index a4cc5b4..949bf88 100644
--- a/.github/workflows/deploy_docs.yml
+++ b/.github/workflows/deploy_docs.yml
@@ -6,8 +6,8 @@ on:
workflow_dispatch:
env:
- INSTANCE: 'Writerside/docs'
- ARTIFACT: 'webHelpDocs2-all.zip'
+ INSTANCE: 'Writerside/dcs'
+ ARTIFACT: 'webHelpDCS2-all.zip'
DOCKER_VERSION: '242.21870'
jobs: