From ddcf3dd331bcf8952f3e1a2baed87dfb17bd09f2 Mon Sep 17 00:00:00 2001 From: berfinyuksel Date: Tue, 11 Nov 2025 10:42:01 +0100 Subject: [PATCH 1/2] Use reusable documentation workflow and disable old docs workflow --- .github/workflows/docs.yaml | 140 ++++++++++++++++---------------- .github/workflows/docs.yaml.bak | 69 ++++++++++++++++ .github/workflows/new-docs.yml | 37 +++++++++ 3 files changed, 178 insertions(+), 68 deletions(-) create mode 100644 .github/workflows/docs.yaml.bak create mode 100644 .github/workflows/new-docs.yml diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 8480e20e..c2792833 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,69 +1,73 @@ +# Original docs workflow disabled in favor of new-docs.yml +# This file is kept only for reference. The active workflow is .github/workflows/new-docs.yml +# Backup of the original content: .github/workflows/docs.yaml.bak -name: "Documentation" - -on: - pull_request_target: - branches: - - "[0-9]+.[0-9]+" - - "[0-9]+.x" - paths: - - 'doc/**' - - '.github/workflows/docs.yaml' - - 'README.md' - push: - branches: - - "[0-9]+.[0-9]+" - - "[0-9]+.x" - - "*_actions" - paths: - - 'doc/**' - - 'README.md' - -permissions: - contents: read - -jobs: - docs: - name: "Generate docs Pimcore Docs Generator" - runs-on: "ubuntu-latest" - steps: - - name: "Checkout code" - uses: "actions/checkout@v4" - with: - ref: ${{ github.event.pull_request.head.sha }} - - name: "Checkout Docs Generator" - uses: "actions/checkout@v4" - with: - repository: "pimcore/docs-generator" - ref: "main" - path: "./docs-generator" - token: ${{ secrets.DOCS_GENERATOR_ACCESS_TOKEN }} - - - name: "Install Node" - uses: actions/setup-node@v4 - with: - node-version: 'lts/*' - registry-url: 'https://registry.npmjs.org' - - - name: Prepare Docs - working-directory: "./docs-generator" - run: | - mkdir docs - # copy docs to working directory - cp -r ../doc ./docs/ - - # copy readme to working directory - cp -r ../README.md ./docs/ - - # copy index page - cp bin/resources/00_index_empty.md ./docs/00_index.md - - # use special docusaurus config (to exclude search plugin) and check for broken links - mv docusaurus.config.js.repos-tests docusaurus.config.js - - - name: Build Docs - working-directory: "./docs-generator" - run: | - npm install - npm run build - +# +# name: "Documentation" +# +# on: +# pull_request_target: +# branches: +# - "[0-9]+.[0-9]+" +# - "[0-9]+.x" +# paths: +# - 'doc/**' +# - '.github/workflows/docs.yaml' +# - 'README.md' +# push: +# branches: +# - "[0-9]+.[0-9]+" +# - "[0-9]+.x" +# - "*_actions" +# paths: +# - 'doc/**' +# - 'README.md' +# +# permissions: +# contents: read +# +# jobs: +# docs: +# name: "Generate docs Pimcore Docs Generator" +# runs-on: "ubuntu-latest" +# steps: +# - name: "Checkout code" +# uses: "actions/checkout@v4" +# with: +# ref: ${{ github.event.pull_request.head.sha }} +# - name: "Checkout Docs Generator" +# uses: "actions/checkout@v4" +# with: +# repository: "pimcore/docs-generator" +# ref: "main" +# path: "./docs-generator" +# token: ${{ secrets.DOCS_GENERATOR_ACCESS_TOKEN }} +# +# - name: "Install Node" +# uses: actions/setup-node@v4 +# with: +# node-version: 'lts/*' +# registry-url: 'https://registry.npmjs.org' +# +# - name: Prepare Docs +# working-directory: "./docs-generator" +# run: | +# mkdir docs +# # copy docs to working directory +# cp -r ../doc ./docs/ +# +# # copy readme to working directory +# cp -r ../README.md ./docs/ +# +# # copy index page +# cp bin/resources/00_index_empty.md ./docs/00_index.md +# +# # use special docusaurus config (to exclude search plugin) and check for broken links +# mv docusaurus.config.js.repos-tests docusaurus.config.js +# +# - name: Build Docs +# working-directory: "./docs-generator" +# run: | +# npm install +# npm run build +# diff --git a/.github/workflows/docs.yaml.bak b/.github/workflows/docs.yaml.bak new file mode 100644 index 00000000..8480e20e --- /dev/null +++ b/.github/workflows/docs.yaml.bak @@ -0,0 +1,69 @@ + +name: "Documentation" + +on: + pull_request_target: + branches: + - "[0-9]+.[0-9]+" + - "[0-9]+.x" + paths: + - 'doc/**' + - '.github/workflows/docs.yaml' + - 'README.md' + push: + branches: + - "[0-9]+.[0-9]+" + - "[0-9]+.x" + - "*_actions" + paths: + - 'doc/**' + - 'README.md' + +permissions: + contents: read + +jobs: + docs: + name: "Generate docs Pimcore Docs Generator" + runs-on: "ubuntu-latest" + steps: + - name: "Checkout code" + uses: "actions/checkout@v4" + with: + ref: ${{ github.event.pull_request.head.sha }} + - name: "Checkout Docs Generator" + uses: "actions/checkout@v4" + with: + repository: "pimcore/docs-generator" + ref: "main" + path: "./docs-generator" + token: ${{ secrets.DOCS_GENERATOR_ACCESS_TOKEN }} + + - name: "Install Node" + uses: actions/setup-node@v4 + with: + node-version: 'lts/*' + registry-url: 'https://registry.npmjs.org' + + - name: Prepare Docs + working-directory: "./docs-generator" + run: | + mkdir docs + # copy docs to working directory + cp -r ../doc ./docs/ + + # copy readme to working directory + cp -r ../README.md ./docs/ + + # copy index page + cp bin/resources/00_index_empty.md ./docs/00_index.md + + # use special docusaurus config (to exclude search plugin) and check for broken links + mv docusaurus.config.js.repos-tests docusaurus.config.js + + - name: Build Docs + working-directory: "./docs-generator" + run: | + npm install + npm run build + diff --git a/.github/workflows/new-docs.yml b/.github/workflows/new-docs.yml new file mode 100644 index 00000000..77ff9a8e --- /dev/null +++ b/.github/workflows/new-docs.yml @@ -0,0 +1,37 @@ +name: "Documentation (Reusable)" + +on: + pull_request_target: + branches: + - "[0-9]+.[0-9]+" + - "[0-9]+.x" + - "reusable-workflows" + paths: + - "doc/**" + - ".github/workflows/docs.yaml" + - ".github/workflows/docs.yml" + - ".github/workflows/new-docs.yml" + - "README.md" + push: + branches: + - "[0-9]+.[0-9]+" + - "[0-9]+.x" + - "*_actions" + - "reusable-workflows" + paths: + - "doc/**" + - ".github/workflows/docs.yaml" + - ".github/workflows/docs.yml" + - ".github/workflows/new-docs.yml" + - "README.md" + +permissions: + contents: read + +jobs: + docs: + uses: pimcore/workflows-collection-public/.github/workflows/reusable-docs.yaml@reusable-workflows + with: + docs_path: "doc" + secrets: + DOCS_GENERATOR_ACCESS_TOKEN: ${{ secrets.DOCS_GENERATOR_ACCESS_TOKEN }} From 4380d56c95b926036b4a56917d5bb28875c17448 Mon Sep 17 00:00:00 2001 From: berfinyuksel Date: Tue, 11 Nov 2025 10:52:36 +0100 Subject: [PATCH 2/2] Remove docs workflow backup files --- .github/workflows/docs.yaml.bak | 69 --------------------------------- 1 file changed, 69 deletions(-) delete mode 100644 .github/workflows/docs.yaml.bak diff --git a/.github/workflows/docs.yaml.bak b/.github/workflows/docs.yaml.bak deleted file mode 100644 index 8480e20e..00000000 --- a/.github/workflows/docs.yaml.bak +++ /dev/null @@ -1,69 +0,0 @@ - -name: "Documentation" - -on: - pull_request_target: - branches: - - "[0-9]+.[0-9]+" - - "[0-9]+.x" - paths: - - 'doc/**' - - '.github/workflows/docs.yaml' - - 'README.md' - push: - branches: - - "[0-9]+.[0-9]+" - - "[0-9]+.x" - - "*_actions" - paths: - - 'doc/**' - - 'README.md' - -permissions: - contents: read - -jobs: - docs: - name: "Generate docs Pimcore Docs Generator" - runs-on: "ubuntu-latest" - steps: - - name: "Checkout code" - uses: "actions/checkout@v4" - with: - ref: ${{ github.event.pull_request.head.sha }} - - name: "Checkout Docs Generator" - uses: "actions/checkout@v4" - with: - repository: "pimcore/docs-generator" - ref: "main" - path: "./docs-generator" - token: ${{ secrets.DOCS_GENERATOR_ACCESS_TOKEN }} - - - name: "Install Node" - uses: actions/setup-node@v4 - with: - node-version: 'lts/*' - registry-url: 'https://registry.npmjs.org' - - - name: Prepare Docs - working-directory: "./docs-generator" - run: | - mkdir docs - # copy docs to working directory - cp -r ../doc ./docs/ - - # copy readme to working directory - cp -r ../README.md ./docs/ - - # copy index page - cp bin/resources/00_index_empty.md ./docs/00_index.md - - # use special docusaurus config (to exclude search plugin) and check for broken links - mv docusaurus.config.js.repos-tests docusaurus.config.js - - - name: Build Docs - working-directory: "./docs-generator" - run: | - npm install - npm run build -