Use reusable documentation workflow and disable old docs workflow

Author: berfinyuksel

.github/workflows/docs.yaml

@@ -1,71 +1,75 @@
+# 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/**'
-            - '.github/workflows/docs.yaml'
-            - '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/**'
+#             - '.github/workflows/docs.yaml'
+#             - '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
+#                   

.github/workflows/docs.yaml.bak

@@ -0,0 +1,71 @@
+
+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/**'
+            - '.github/workflows/docs.yaml'
+            - '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
+                  

.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 }}