Improve release workflows

Author: Hasenpfote

.github/settings/release-config.yml

@@ -0,0 +1,2 @@
+default:
+  enable-docs: true

.github/workflows/docs.yml

@@ -4,7 +4,23 @@ name: '📚 Publish docs via GitHub Pages'
 # build the documentation whenever there are new commits on main
 on:
   workflow_dispatch:
+    inputs:
+      dry-run:
+        required: false
+        default: true
+        type: boolean
+
   workflow_call:
+    inputs:
+      dry-run:
+        required: false
+        default: true
+        type: boolean
+
+    outputs:
+      page-url:
+        description: 'URL to the docs published on GitHub Pages'
+        value: ${{ jobs.deploy.outputs.page-url }}
 
 jobs:
   config-prep:
@@ -65,13 +81,17 @@ jobs:
   # This is a separate job so that only actions/deploy-pages has the necessary permissions.
   deploy:
     needs: build
-    runs-on: ubuntu-latest
+    if: ${{ !inputs.dry-run }}
     permissions:
       pages: write
       id-token: write
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    outputs:
+      page-url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - id: deployment
         uses: actions/deploy-pages@v1

.github/workflows/release.yml

@@ -0,0 +1,73 @@
+name: '🎁 Release'
+
+on:
+  workflow_dispatch:
+    inputs:
+      dry-run:
+        required: false
+        default: true
+        type: boolean
+
+  release:
+    types: [published]
+
+jobs:
+  config-prep:
+    runs-on: ubuntu-latest
+    outputs:
+      dry-run: ${{ github.event_name == 'workflow_dispatch' && inputs.dry-run }}
+      enable-docs: ${{ steps.read-file.outputs.content }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Read YAML file
+        id: read-file
+        uses: ./.github/actions/read-yaml
+        with:
+          path: .github/settings/release-config.yml
+          filter: '.default.enable-docs'
+
+  publish-package:
+    needs: config-prep
+    uses: ./.github/workflows/testpypi.yml
+    with:
+      dry-run: ${{ fromJson(needs.config-prep.outputs.dry-run) }}
+    secrets: inherit
+
+  publish-docs:
+    needs: [config-prep, publish-package]
+    if: needs.config-prep.outputs.enable-docs == 'true'
+    uses: ./.github/workflows/docs.yml
+    with:
+      dry-run: ${{ fromJson(needs.config-prep.outputs.dry-run) }}
+
+  report:
+    needs: [publish-package, publish-docs]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Debug
+        shell: bash
+        run: |
+          echo ${{ needs.publish-package.result }}
+          echo ${{ needs.publish-docs.result }}
+
+      - name: Generate a summary
+        uses: actions/github-script@v6
+        with:
+          script: |
+            const name_to_url = new Map([
+              ['TestPyPI', '${{ needs.publish-package.outputs.page-url }}'],
+            ]);
+            if ('${{ needs.publish-docs.outputs.page-url }}' != '') {
+              name_to_url.set('GitHub Pages', '${{ needs.publish-docs.outputs.page-url }}');
+            }
+
+            const list = [...name_to_url].map(([name, url]) =>
+              `<a href="${url}">${name}</a>`
+            );
+
+            await core.summary
+              .addHeading('Links to published content')
+              .addList(list)
+              .write()

.github/workflows/testpypi.yml

@@ -1,9 +1,17 @@
 name: '📦 Publish the package to TestPyPI'
 
 on:
-  workflow_dispatch:
-  release:
-    types: [published]
+  workflow_call:
+    inputs:
+      dry-run:
+        required: false
+        default: true
+        type: boolean
+
+    outputs:
+      page-url:
+        description: 'URL to the package published on TestPyPI'
+        value: ${{ jobs.make-url.outputs.page-url }}
 
 jobs:
   config-prep:
@@ -26,6 +34,8 @@ jobs:
     env: ${{ fromJson(needs.config-prep.outputs.env) }}
 
     runs-on: ubuntu-latest
+    outputs:
+      api-end-point: ${{ steps.configure-poetry.outputs.api-end-point }}
     steps:
       - name: Checkout
         uses: actions/checkout@v3
@@ -49,11 +59,14 @@ jobs:
           poetry-path: ${{ env.poetry-path }}
 
       - name: Configure Poetry
+        id: configure-poetry
         env:
           TESTPYPI_API_TOKEN: ${{ secrets.TESTPYPI_API_TOKEN }}
+        shell: bash
         run: |
           poetry config repositories.test-pypi https://test.pypi.org/legacy/
           poetry config pypi-token.test-pypi $TESTPYPI_API_TOKEN
+          echo "api-end-point=$(poetry config repositories.test-pypi | sed 's/\x27/"/g' | jq '.url' | sed 's/"//g')" >> $GITHUB_OUTPUT
 
       - name: Install dependencies
         run: |
@@ -63,11 +76,36 @@ jobs:
         run: |
           poetry build
 
+      - name: Publish --dry-run
+        if: inputs.dry-run == true
+        run: |
+          poetry publish -r test-pypi --dry-run
+
       - name: Publish
+        if: inputs.dry-run != true
         run: |
           poetry publish -r test-pypi
 
-  docs:
-    if: true # true if documentation is needed.
+  make-url:
     needs: deploy
-    uses: ./.github/workflows/docs.yml
+    runs-on: ubuntu-latest
+    outputs:
+      page-url: ${{ steps.make-url.outputs.url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Read TOML file
+        uses: SebRollen/[email protected]
+        id: read-toml
+        with:
+          file: pyproject.toml
+          field: 'tool.poetry.name'
+
+      - name: Make URL
+        id: make-url
+        shell: bash
+        run: |
+          api_end_point='${{ needs.deploy.outputs.api-end-point }}'
+          protocol_domain="$(echo "${api_end_point}" | grep -Eo '^http[s]?://[^/]+')/"
+          echo "url=${protocol_domain}project/${{ steps.read-toml.outputs.value }}/" >> $GITHUB_OUTPUT