use proper links in docs, automatic doc push and add pdf to releases

DitZii · Apr 29, 2023 · ad16067 · ad16067
1 parent 08e1d15
commit ad16067
Show file tree

Hide file tree

Showing 27 changed files with 568 additions and 348 deletions.
diff --git a/.github/workflows/beta.yml b/.github/workflows/beta.yml
@@ -368,9 +368,9 @@ jobs:
       BW_VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
     secrets:
       PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
-  
-  # Create tag + release + discussion
-  publish-beta:
+
+  # Create doc PDF
+  doc-pdf:
     needs: [
       push-bunkerweb,
       push-scheduler,
@@ -381,38 +381,30 @@ jobs:
       push-rhel,
       push-fedora
     ]
+    uses: ./.github/workflows/doc-to-pdf.yml
+    with:
+      VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
+
+  # Push on GH
+  push-gh:
+    needs: [doc-pdf]
     permissions:
       contents: write
-    steps:
-      - uses: actions/checkout@v3
-      - uses: rickstaa/action-create-tag@v1
-        name: Create tag
-        with:
-          tag: "v${{ jobs.wait-builds.steps.getversion.outputs.version }}"
-          message: "v${{ jobs.wait-builds.steps.getversion.outputs.version }}"
-      - name: Extract changelog
-        id: getchangelog
-        run: echo "::set-output name=content::$(awk -v n=2 '/##/{n--}; n > 0' CHANGELOG.md | grep -v '# Changelog' | grep -v '##' | sed '/^$/d')"
-      - name: Create release
-        uses: softprops/action-gh-release@v1
-        with:
-          body: |
-            Documentation : https://docs.bunkerweb.io/${{ jobs.wait-builds.steps.getversion.outputs.version }}/
+    uses: ./.github/workflow/push-github.yml
+    with:
+      VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
+      PRERELEASE: true
+
+  # Push doc
+  push-doc:
+    needs: [publish-gh]
+    permissions:
+      contents: write
+    uses: ./.github/workflow/push-doc.yml
+      VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
+      ALIAS: beta
 
-            Docker tags : 
-            - `bunkerity/bunkerweb:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
-            - `bunkerity/bunkerweb-scheduler:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
-            - `bunkerity/bunkerweb-autoconf:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
-            - `bunkerity/bunkerweb-ui:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
 
-            Linux packages : https://packagecloud.io/app/bunkerity/bunkerweb/search?q=${{ jobs.wait-builds.steps.getversion.outputs.version }}&filter=all&dist=
 
-            Changelog : 
-            ${{steps.getchangelog.outputs.content}}
-          draft: false
-          prerelease: true
-          name: v${{ jobs.wait-builds.steps.getversion.outputs.version }}
-          tag_name: v${{ jobs.wait-builds.steps.getversion.outputs.version }}
-          discussion_category_name: Announcements
 
 
diff --git a/.github/workflows/doc-to-pdf.yml b/.github/workflows/doc-to-pdf.yml
@@ -0,0 +1,39 @@
+name: Generate documentation PDF (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      VERSION:
+        required: true
+        type: string
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Prepare
+      - name: Checkout source code
+        uses: actions/checkout@v3
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install doc requirements
+        run: pip install -r docs/requirements.txt
+      - name: Install chromium
+        uses: apt install chromium-browser
+      - name: Install node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install puppeteer
+        run: npm i --save puppeteer
+      - name: Run mkdocs serve in background
+        run: mkdocs serve & sleep 10
+      - name: Run pdf script
+        run: node docs/misc/pdf.js http://localhost:8000/print_page/ BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf 'BunkerWeb documentation v${{ inputs.VERSION }}'
+      - uses: actions/upload-artifact@v3
+        with:
+          name: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf
+          path: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf
+
diff --git a/.github/workflows/push-doc.yml b/.github/workflows/push-doc.yml
@@ -0,0 +1,28 @@
+name: Push documentation (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      VERSION:
+        required: true
+        type: string
+      ALIAS:
+        required: true
+        type: string
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v3
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+      - name: Install doc requirements
+        run: pip install -r docs/requirements.txt
+      - name: Push doc
+        run: mike deploy --update-aliases --push ${{ inputs.VERSION }} ${{ inputs.ALIAS }}
+      - name: Set default doc
+        if: inputs.ALIAS == 'latest'
+        run: mike set-default --push latest
diff --git a/.github/workflows/push-github.yml b/.github/workflows/push-github.yml
@@ -0,0 +1,57 @@
+name: Push on GitHub (REUSABLE)
+
+on:
+  workflow_call:
+    inputs:
+      VERSION:
+        required: true
+        type: string
+      PRERELEASE:
+        required: true
+        type: boolean
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout
+      - uses: actions/checkout@v3
+      # Get PDF doc
+      - name: Get documentation
+        uses: actions/download-artifact@v3
+        with:
+          name: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf
+          path: BunkerWeb_documentation_v${{ inputs.VERSION }}.pdf
+      # Create tag
+      - uses: rickstaa/action-create-tag@v1
+        name: Create tag
+        with:
+          tag: "v${{ inputs.VERSION }}"
+          message: "v${{ inputs.VERSION }}"
+      # Extract changelog
+      - name: Extract changelog
+        id: getchangelog
+        run: echo "::set-output name=content::$(awk -v n=2 '/##/{n--}; n > 0' CHANGELOG.md | grep -v '# Changelog' | grep -v '##' | sed '/^$/d')"
+      # Create release
+      - name: Create release
+        uses: softprops/action-gh-release@v1
+        with:
+          body: |
+            Documentation : https://docs.bunkerweb.io/${{ inputs.VERSION }}/
+
+            Docker tags : 
+            - `bunkerity/bunkerweb:${{ inputs.VERSION }}`
+            - `bunkerity/bunkerweb-scheduler:${{ inputs.VERSION }}`
+            - `bunkerity/bunkerweb-autoconf:${{ inputs.VERSION }}`
+            - `bunkerity/bunkerweb-ui:${{ inputs.VERSION }}`
+
+            Linux packages : https://packagecloud.io/app/bunkerity/bunkerweb/search?q=${{ inputs.VERSION }}&filter=all&dist=
+
+            Changelog : 
+            ${{steps.getchangelog.outputs.content}}
+          draft: false
+          prerelease: ${{ inputs.PRERELEASE }}
+          name: v${{ inputs.VERSION }}
+          tag_name: v${{ inputs.VERSION }}
+          discussion_category_name: Announcements
+
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -344,9 +344,9 @@ jobs:
       BW_VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
     secrets:
       PACKAGECLOUD_TOKEN: ${{ secrets.PACKAGECLOUD_TOKEN }}
-  
-  # Create tag + release + discussion
-  publish-latest:
+
+  # Create doc PDF
+  doc-pdf:
     needs: [
       push-bunkerweb,
       push-scheduler,
@@ -357,38 +357,80 @@ jobs:
       push-rhel,
       push-fedora
     ]
+    uses: ./.github/workflows/doc-to-pdf.yml
+    with:
+      VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
+
+  # Push on GH
+  push-gh:
+    needs: [doc-pdf]
+    permissions:
+      contents: write
+    uses: ./.github/workflow/push-github.yml
+    with:
+      VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
+      PRERELEASE: false
+
+  # Push doc
+  push-doc:
+    needs: [publish-gh]
+    permissions:
+      contents: write
+    uses: ./.github/workflow/push-doc.yml
+      VERSION: ${{ jobs.wait-builds.steps.getversion.outputs.version }}
+      ALIAS: latest
+
+  # Update Docker Hub description
+  update-docker-hub:
+    needs: [
+      push-bunkerweb,
+      push-scheduler,
+      push-autoconf,
+      push-ui
+    ]
     permissions:
       contents: write
     steps:
       - uses: actions/checkout@v3
-      - uses: rickstaa/action-create-tag@v1
-        name: Create tag
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
         with:
-          tag: "v${{ jobs.wait-builds.steps.getversion.outputs.version }}"
-          message: "v${{ jobs.wait-builds.steps.getversion.outputs.version }}"
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
       - name: Extract changelog
         id: getchangelog
         run: echo "::set-output name=content::$(awk -v n=2 '/##/{n--}; n > 0' CHANGELOG.md | grep -v '# Changelog' | grep -v '##' | sed '/^$/d')"
-      - name: Create release
-        uses: softprops/action-gh-release@v1
+      - name: Update Docker Hub description for BW
+        uses: peter-evans/dockerhub-description@v3
         with:
-          body: |
-            Documentation : https://docs.bunkerweb.io/${{ jobs.wait-builds.steps.getversion.outputs.version }}/
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+          repository: bunkerity/bunkerweb
+          readme-filepath: ./README.md
+      - name: Update Docker Hub description for scheduler
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+          repository: bunkerity/bunkerweb-scheduler
+          readme-filepath: ./README.md
+      - name: Update Docker Hub description for autoconf
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+          repository: bunkerity/bunkerweb-autoconf
+          readme-filepath: ./README.md
+      - name: Update Docker Hub description for UI
+        uses: peter-evans/dockerhub-description@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_TOKEN }}
+          repository: bunkerity/bunkerweb-ui
+          readme-filepath: ./README.md
+
 
-            Docker tags : 
-            - `bunkerity/bunkerweb:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
-            - `bunkerity/bunkerweb-scheduler:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
-            - `bunkerity/bunkerweb-autoconf:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
-            - `bunkerity/bunkerweb-ui:${{ jobs.wait-builds.steps.getversion.outputs.version }}`
 
-            Linux packages : https://packagecloud.io/app/bunkerity/bunkerweb/search?q=${{ jobs.wait-builds.steps.getversion.outputs.version }}&filter=all&dist=
 
-            Changelog : 
-            ${{steps.getchangelog.outputs.content}}
-          draft: false
-          prerelease: false
-          name: v${{ jobs.wait-builds.steps.getversion.outputs.version }}
-          tag_name: v${{ jobs.wait-builds.steps.getversion.outputs.version }}
-          discussion_category_name: Announcements
 
 
diff --git a/.github/workflows/staging-tests.yml b/.github/workflows/staging-tests.yml
@@ -63,9 +63,9 @@ jobs:
       - name: Pull BW linux debian test image
         if: inputs.TYPE == 'linux'
         run: docker pull ${{ secrets.PRIVATE_REGISTRY }}/infra/debian-tests:staging && docker tag ${{ secrets.PRIVATE_REGISTRY }}/infra/debian-tests:staging local/debian:latest
-      - name: Pull BW linux centos test image
-        if: inputs.TYPE == 'linux'
-        run: docker pull ${{ secrets.PRIVATE_REGISTRY }}/infra/centos-tests:staging && docker tag ${{ secrets.PRIVATE_REGISTRY }}/infra/centos-tests:staging local/centos:latest
+      # - name: Pull BW linux centos test image
+      #   if: inputs.TYPE == 'linux'
+      #   run: docker pull ${{ secrets.PRIVATE_REGISTRY }}/infra/centos-tests:staging && docker tag ${{ secrets.PRIVATE_REGISTRY }}/infra/centos-tests:staging local/centos:latest
       - name: Pull BW linux fedora test image
         if: inputs.TYPE == 'linux'
         run: docker pull ${{ secrets.PRIVATE_REGISTRY }}/infra/fedora-tests:staging && docker tag ${{ secrets.PRIVATE_REGISTRY }}/infra/fedora-tests:staging local/fedora:latest