Merge pull request #488 from oss-slu/433-docs-should-not-be-publishedmade-live-each-time-they-are-updated

Separate asciidoc publish to separate workflow

Author: leandrumartin

.github/workflows/asciidoc-build.yml

@@ -3,25 +3,26 @@ name: build adocs
 on:
   push:
     branches:
-    - main
-    - develop
+      - develop
+  pull_request:
+    branches:
+      - main
+      - develop
+  workflow_call:
 
 jobs:
   adoc_build:
     runs-on: ubuntu-latest
     name: ASCII DOC build
     steps:
-    - name: Checkout code
-      uses: actions/checkout@v2
-    - name: Get build container
-      id: adocbuild
-      uses: tonynv/asciidoctor-action@master
-      with:
-          program: "./gradlew asciidoctor"
-    - name: Deploy docs to ghpages
-      uses: peaceiris/actions-gh-pages@v3
-      with: 
-        deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-        publish_branch: gh-pages
-        publish_dir: ./pi4micronaut-utils/build/docs/asciidoc/
-
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Get build container
+        uses: tonynv/asciidoctor-action@v2
+        with:
+            program: "./gradlew asciidoctor"
+      - name: Upload AsciiDoc output
+        uses: actions/upload-artifact@v4
+        with:
+          name: asciidoc-output
+          path: pi4micronaut-utils/build/docs/asciidoc/

.github/workflows/asciidoc-publish.yml

@@ -0,0 +1,31 @@
+name: Publish AsciiDoc
+permissions:
+  contents: read
+on:
+  workflow_call:
+    secrets:
+      ACTIONS_DEPLOY_KEY:
+        required: true
+
+jobs:
+  build:
+    uses: ./.github/workflows/asciidoc-build.yml
+  adoc_publish:
+    needs: build
+    runs-on: ubuntu-latest
+    name: ASCII DOC publish
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Download AsciiDoc output
+        uses: actions/download-artifact@v4
+        with:
+          name: asciidoc-output
+          path: pi4micronaut-utils/build/docs/asciidoc/
+      - name: Deploy docs to ghpages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_branch: gh-pages
+          publish_dir: ./pi4micronaut-utils/build/docs/asciidoc/
+          keep_files: true

.github/workflows/javadoc-gh-pages.yml

@@ -4,7 +4,7 @@ permissions:
   pages: write
   id-token: write
 on:
-  workflow_call: 
+  workflow_call:
 
 jobs:
   build:
@@ -40,10 +40,8 @@ jobs:
         with:
           name: javadoc
           path: ./javadoc
-          retention-days: 1
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v4
-        if: github.ref == 'refs/heads/develop'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./javadoc

.github/workflows/publish-docs.yml

@@ -1,14 +1,16 @@
 name: Publish Documentation
-
+permissions:
+  contents: write
 on:
   push:
     branches:
       - main
-      - develop
 
 jobs:
   publish-asciidoc:
-    uses: ./.github/workflows/asciidoc-build.yml
+    uses: ./.github/workflows/asciidoc-publish.yml
+    secrets:
+      ACTIONS_DEPLOY_KEY: ${{ secrets.ACTIONS_DEPLOY_KEY }}
 
   publish-javadoc:
     needs: publish-asciidoc