From ecfead6bdb3bb6eea055ddb97e4a85ed2e8a3589 Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Thu, 22 Jan 2026 22:19:23 +0530 Subject: [PATCH 1/9] build testing --- .github/workflows/docbook.yml | 101 ++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 .github/workflows/docbook.yml diff --git a/.github/workflows/docbook.yml b/.github/workflows/docbook.yml new file mode 100644 index 00000000..31830f2f --- /dev/null +++ b/.github/workflows/docbook.yml @@ -0,0 +1,101 @@ +name: Validate/build docs + +on: + push: + paths: + - 'DC-*' + - 'xml/**' + - 'adoc/**' + - 'images/src/**' + - '**/DC-*' + - '**/xml/**' + - '**/adoc/**' + - '**/images/src/**' + +jobs: + select-dc-files: + runs-on: ubuntu-latest + outputs: + validate-list: ${{ steps.select-dc-validate.outputs.dc-list }} + build-list: ${{ steps.select-dc-build.outputs.dc-list }} + allow-build: ${{ steps.select-dc-build.outputs.allow-build }} + relevant-branches: ${{ steps.select-dc-build.outputs.relevant-branches }} + steps: + - uses: actions/checkout@v4 + + - name: Checking basic soundness of DC files + uses: openSUSE/doc-ci@gha-select-dcs + with: + mode: soundness + + - name: Selecting DC files to validate + id: select-dc-validate + uses: openSUSE/doc-ci@gha-select-dcs + with: + mode: list-validate + + - name: Selecting DC files to build + id: select-dc-build + uses: openSUSE/doc-ci@gha-select-dcs + with: + mode: list-build + original-org: SUSE + + validate: + runs-on: ubuntu-latest + needs: select-dc-files + strategy: + # don't cancel all validation runners when one of them fails, we want full results + fail-fast: false + matrix: + dc-files: ${{ fromJson(needs.select-dc-files.outputs.validate-list) }} + steps: + - uses: actions/checkout@v4 + - name: Validating DC file(s) ${{ matrix.dc-files }} + uses: openSUSE/doc-ci@gha-validate + with: + dc-files: ${{ matrix.dc-files }} + + + build-html: + runs-on: ubuntu-latest + needs: [select-dc-files, validate] + if: ${{ needs.select-dc-files.outputs.allow-build == 'true' }} + outputs: + artifact-name: ${{ steps.build-dc.outputs.artifact-name }} + artifact-dir: ${{ steps.build-dc.outputs.artifact-dir }} + strategy: + matrix: + dc-files: ${{ fromJson(needs.select-dc-files.outputs.build-list) }} + steps: + - uses: actions/checkout@v4 + - name: Building DC file(s) ${{ matrix.dc-files }} + id: build-dc + uses: openSUSE/doc-ci@gha-build + with: + dc-files: ${{ matrix.dc-files }} + - name: Uploading builds as artifact + uses: actions/upload-artifact@v4 + with: + name: ${{ steps.build-dc.outputs.artifact-name }} + path: ${{ steps.build-dc.outputs.artifact-dir }}/* + retention-days: 3 + + + publish: + runs-on: ubuntu-latest + if: ${{ success() }} + needs: [select-dc-files, build-html] + continue-on-error: true + steps: + - name: Downloading all build artifacts + uses: actions/download-artifact@v4 + with: + path: artifact-dir + - name: Publishing builds on susedoc.github.io + uses: openSUSE/doc-ci@gha-publish + env: + DEPLOY_KEY: ${{ secrets.DEPLOY_KEY_SLE }} + with: + artifact-path: artifact-dir + relevant-dirs: ${{ needs.select-dc-files.outputs.relevant-branches }} From 8c366750b6f0c74eeabb8983082d383401c361ed Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Fri, 23 Jan 2026 12:58:17 +0530 Subject: [PATCH 2/9] build testing 2 --- .github/workflows/{ => workflows}/docbook.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{ => workflows}/docbook.yml (100%) diff --git a/.github/workflows/docbook.yml b/.github/workflows/workflows/docbook.yml similarity index 100% rename from .github/workflows/docbook.yml rename to .github/workflows/workflows/docbook.yml From fb492a8f369a421d7b9b1095c88bc6a19bc44571 Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Tue, 27 Jan 2026 20:31:06 +0530 Subject: [PATCH 3/9] build testing - 27 Jan --- .github/workflows/deploy.yml | 47 ------------------- .github/workflows/{workflows => }/docbook.yml | 0 .github/workflows/test-deploy.yml | 30 ------------ 3 files changed, 77 deletions(-) delete mode 100644 .github/workflows/deploy.yml rename .github/workflows/{workflows => }/docbook.yml (100%) delete mode 100644 .github/workflows/test-deploy.yml diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml deleted file mode 100644 index 416046f4..00000000 --- a/.github/workflows/deploy.yml +++ /dev/null @@ -1,47 +0,0 @@ -name: Deploy to GitHub Pages - -# https://github.com/peaceiris/actions-gh-pages/issues/852 -permissions: - contents: write - -on: - workflow_dispatch: - push: - branches: - - main - # Review gh actions docs if you want to further define triggers, paths, etc - # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on - -jobs: - deploy: - name: Deploy to GitHub Pages - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Run the docs build in a container - uses: addnab/docker-run-action@v3 - with: - image: registry.opensuse.org/home/atgracey/cnbp/containers/builder:latest - options: -v ${{ github.workspace }}:/docs - run: | - cd /docs/asciidoc - daps -d DC-edge html - - # Popular action to deploy to GitHub Pages: - # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - # Build output to publish to the `gh-pages` branch: - publish_dir: ./asciidoc/build/edge/html/edge - # The following lines assign commit authorship to the official - # GH-Actions bot for deploys to `gh-pages` branch: - # https://github.com/actions/checkout/issues/13#issuecomment-724415212 - # The GH actions bot is used by default if you didn't specify the two fields. - # You can swap them out with your own user credentials. - user_name: github-actions[bot] - user_email: 41898282+github-actions[bot]@users.noreply.github.com diff --git a/.github/workflows/workflows/docbook.yml b/.github/workflows/docbook.yml similarity index 100% rename from .github/workflows/workflows/docbook.yml rename to .github/workflows/docbook.yml diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml deleted file mode 100644 index 3f9329b8..00000000 --- a/.github/workflows/test-deploy.yml +++ /dev/null @@ -1,30 +0,0 @@ -name: Test deployment - -# https://github.com/peaceiris/actions-gh-pages/issues/852 -permissions: - contents: read - -on: - workflow_dispatch: - pull_request: - branches: - - main - - "release-3.*" - # Review gh actions docs if you want to further define triggers, paths, etc - # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on - -jobs: - test-deploy: - name: Test deployment - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - - name: Run the docs build in a container - uses: addnab/docker-run-action@v3 - with: - image: registry.opensuse.org/home/atgracey/cnbp/containers/builder:latest - options: -v ${{ github.workspace }}:/docs - run: | - cd /docs/asciidoc - daps -d DC-edge html From 518c05a9f17213b45949d88742f960f5f5af9ad2 Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Tue, 27 Jan 2026 21:46:18 +0530 Subject: [PATCH 4/9] added write permission --- .github/workflows/docbook.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.github/workflows/docbook.yml b/.github/workflows/docbook.yml index 31830f2f..43b66432 100644 --- a/.github/workflows/docbook.yml +++ b/.github/workflows/docbook.yml @@ -1,6 +1,11 @@ name: Validate/build docs +# https://github.com/peaceiris/actions-gh-pages/issues/852 +permissions: + contents: write + on: + workflow_dispatch: push: paths: - 'DC-*' From 4d4788f156601dd90572ae0afa0cb941b169e347 Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Tue, 27 Jan 2026 21:50:59 +0530 Subject: [PATCH 5/9] added write permission and the main branch --- .github/workflows/docbook.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docbook.yml b/.github/workflows/docbook.yml index 43b66432..e64f74c8 100644 --- a/.github/workflows/docbook.yml +++ b/.github/workflows/docbook.yml @@ -7,6 +7,10 @@ permissions: on: workflow_dispatch: push: + branches: + - main + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on paths: - 'DC-*' - 'xml/**' From 6670ee5449b1fdfd3d17ec1d00d505e06755c0b3 Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Tue, 27 Jan 2026 21:54:20 +0530 Subject: [PATCH 6/9] added pull request from test-deploy file --- .github/workflows/docbook.yml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/docbook.yml b/.github/workflows/docbook.yml index e64f74c8..e10a0e85 100644 --- a/.github/workflows/docbook.yml +++ b/.github/workflows/docbook.yml @@ -6,6 +6,12 @@ permissions: on: workflow_dispatch: + pull_request: + branches: + - main + - "release-3.*" + # Review gh actions docs if you want to further define triggers, paths, etc + # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on push: branches: - main From f3d2201da6b93a09335e3dd8aad357fcab402e50 Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Thu, 29 Jan 2026 21:35:16 +0530 Subject: [PATCH 7/9] added the attribute-dir to publish to suse-edge.github.io --- .github/workflows/docbook.yml | 19 +++++++++++++------ 1 file changed, 13 insertions(+), 6 deletions(-) diff --git a/.github/workflows/docbook.yml b/.github/workflows/docbook.yml index e10a0e85..ac8cbf49 100644 --- a/.github/workflows/docbook.yml +++ b/.github/workflows/docbook.yml @@ -15,6 +15,7 @@ on: push: branches: - main + - "release-3.*" # Review gh actions docs if you want to further define triggers, paths, etc # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on paths: @@ -107,10 +108,16 @@ jobs: uses: actions/download-artifact@v4 with: path: artifact-dir - - name: Publishing builds on susedoc.github.io - uses: openSUSE/doc-ci@gha-publish - env: - DEPLOY_KEY: ${{ secrets.DEPLOY_KEY_SLE }} + - name:Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v3 with: - artifact-path: artifact-dir - relevant-dirs: ${{ needs.select-dc-files.outputs.relevant-branches }} + github_token: ${{ secrets.GITHUB_TOKEN }} + # Build output to publish to the `gh-pages` branch: + publish_dir: "artifact-dir" + # The following lines assign commit authorship to the official + # GH-Actions bot for deploys to `gh-pages` branch: + # https://github.com/actions/checkout/issues/13#issuecomment-724415212 + # The GH actions bot is used by default if you didn't specify the two fields. + # You can swap them out with your own user credentials. + user_name: github-actions[bot] + user_email: 41898282+github-actions[bot]@users.noreply.github.com \ No newline at end of file From 34a3dd0d8d5b0c07d05c286fbb8bd97fee40b7f3 Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Thu, 29 Jan 2026 21:40:28 +0530 Subject: [PATCH 8/9] edited the attribute-dir to publish to suse-edge.github.io --- .github/workflows/docbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docbook.yml b/.github/workflows/docbook.yml index ac8cbf49..951a4857 100644 --- a/.github/workflows/docbook.yml +++ b/.github/workflows/docbook.yml @@ -113,7 +113,7 @@ jobs: with: github_token: ${{ secrets.GITHUB_TOKEN }} # Build output to publish to the `gh-pages` branch: - publish_dir: "artifact-dir" + publish_dir: artifact-dir # The following lines assign commit authorship to the official # GH-Actions bot for deploys to `gh-pages` branch: # https://github.com/actions/checkout/issues/13#issuecomment-724415212 From e1903ebafe9550a62dbf4450a2cae6affdaa76ed Mon Sep 17 00:00:00 2001 From: Ranjini M N Date: Thu, 29 Jan 2026 21:44:43 +0530 Subject: [PATCH 9/9] spacing in line 111 --- .github/workflows/docbook.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docbook.yml b/.github/workflows/docbook.yml index 951a4857..af3d3a2c 100644 --- a/.github/workflows/docbook.yml +++ b/.github/workflows/docbook.yml @@ -108,7 +108,7 @@ jobs: uses: actions/download-artifact@v4 with: path: artifact-dir - - name:Deploy to GitHub Pages + - name: Deploy to GitHub Pages uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }}