chore(ci): rename input and output options for workflows to improve consistency with Github (#666)

Author: jenstroeger

.github/workflows/_build.yaml

@@ -23,14 +23,14 @@ name: Build the package
 on:
   workflow_call:
     inputs:
-      disable_pip_audit:
-        required: true
+      disable-pip-audit:
         type: boolean
+        required: true
         description: Enable or disable running pip_audit to check installed packages for vulnerabilities
     outputs:
       artifacts-sha256:
-        description: The hash of the artifacts
         value: ${{ jobs.build.outputs.artifacts-sha256 }}
+        description: The hash of the artifacts
 permissions:
   contents: read
 env:
@@ -81,7 +81,7 @@ jobs:
     # Audit all currently installed packages for security vulnerabilities. This step can
     # be disabled by setting the repository variable DISABLE_PIP_AUDIT to 'true'.
     - name: Audit installed packages
-      if: ${{ !inputs.disable_pip_audit }}
+      if: ${{ !inputs.disable-pip-audit }}
       run: make audit
 
     # Build the sdist and wheel distribution of the package and docs as a zip file.

.github/workflows/_generate-rebase.yaml

@@ -5,21 +5,21 @@ name: Rebase branch
 on:
   workflow_call:
     inputs:
-      to_head:
+      to-head:
         type: string
         required: true
         description: Branch that is being rebased
-      from_base:
+      from-base:
         type: string
         required: true
         description: Base branch
-      git_user_name:
-        required: true
+      git-user-name:
         type: string
-        description: Name of the git user that rebases and pushes the to_head branch
-      git_user_email:
         required: true
+        description: Name of the git user who rebases and pushes the to_head branch
+      git-user-email:
         type: string
+        required: true
         description: Email address of said git user
     secrets:
       REPO_ACCESS_TOKEN:
@@ -53,7 +53,7 @@ jobs:
         git rebase "$FROM_BASE"
         git push --force-with-lease
       env:
-        USER_NAME: ${{ inputs.git_user_name }}
-        USER_EMAIL: ${{ inputs.git_user_email }}
-        TO_HEAD: ${{ inputs.to_head }}
-        FROM_BASE: ${{ inputs.from_base }}
+        USER_NAME: ${{ inputs.git-user-name }}
+        USER_EMAIL: ${{ inputs.git-user-email }}
+        TO_HEAD: ${{ inputs.to-head }}
+        FROM_BASE: ${{ inputs.from-base }}

.github/workflows/_release-notifications.yaml

@@ -5,15 +5,18 @@ name: Release Notifications
 on:
   workflow_call:
     inputs:
-      repo_name:
-        required: true
+      repo-name:
         type: string
-      release_tag:
         required: true
+        description: Repository name used for the notification
+      release-tag:
         type: string
-      release_url:
         required: true
+        description: Tag name of the release for the notification
+      release-url:
         type: string
+        required: true
+        description: URL to the release page for the notification
     secrets:
       SLACK_WEBHOOK_URL:
         required: true
@@ -34,13 +37,13 @@ jobs:
         SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
         SLACK_WEBHOOK_MSG: |
           {
-            "text": "${{ inputs.repo_name }} published a new release ${{ inputs.release_tag }}",
+            "text": "${{ inputs.repo-name }} published a new release ${{ inputs.release-tag }}",
             "blocks": [
               {
                 "type": "section",
                 "text": {
                   "type": "mrkdwn",
-                  "text": "*${{ inputs.repo_name }}* published a new release <${{ inputs.release_url }}|${{ inputs.release_tag }}>"
+                  "text": "*${{ inputs.repo-name }}* published a new release <${{ inputs.release-url }}|${{ inputs.release-tag }}>"
                 }
               }
             ]

.github/workflows/_wiki-documentation.yaml

@@ -6,21 +6,26 @@ name: Publish Github Wiki documentation
 on:
   workflow_call:
     inputs:
-      release_tag:
-        required: true
+      release-tag:
         type: string
-      release_url:
         required: true
+        description: Tag name of the release used in the Wiki commit message
+      release-url:
         type: string
-      artifact_name:
         required: true
+        description: URL to the release page used in the Wiki commit message
+      artifact-name:
         type: string
-      git_user_name:
         required: true
+        description: Name of the build artifact from which to extract the Wiki pages
+      git-user-name:
         type: string
-      git_user_email:
         required: true
+        description: Name of the git user who commits and pushes the Wiki change set
+      git-user-email:
         type: string
+        required: true
+        description: Email address of said git user
     secrets:
       REPO_ACCESS_TOKEN:
         required: true
@@ -54,7 +59,7 @@ jobs:
     - name: Download artifact
       uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
       with:
-        name: ${{ inputs.artifact_name }}
+        name: ${{ inputs.artifact-name }}
         path: dist
 
     # Unpack the Markdown docs into the Wiki repository. Delete existing files first
@@ -78,9 +83,10 @@ jobs:
           git push
         fi
       env:
-        USER_NAME: ${{ inputs.git_user_name }}
-        USER_EMAIL: ${{ inputs.git_user_email }}
+        USER_NAME: ${{ inputs.git-user-name }}
+        USER_EMAIL: ${{ inputs.git-user-email }}
         WIKI_COMMIT_MESSAGE: |
-          docs: update for ${{ inputs.release_tag }}
+          docs: update for ${{ inputs.release-tag }}
 
-          Link: ${{ inputs.release_url }}
+          Refs: ${{ github.sha }}
+          Link: ${{ inputs.release-url }}

.github/workflows/pr-change-set.yaml

@@ -19,4 +19,4 @@ jobs:
     permissions:
       contents: read
     with:
-      disable_pip_audit: ${{ vars.DISABLE_PIP_AUDIT == 'true' }}
+      disable-pip-audit: ${{ vars.DISABLE_PIP_AUDIT == 'true' }}

.github/workflows/release.yaml

@@ -9,13 +9,6 @@ on:
     - staging
 permissions:
   contents: read
-env:
-  # Duplicate these values for the `wiki` job below!
-  ARTIFACT_NAME: artifact-ubuntu-latest-python-3.11
-  # This is the username and email for the user who commits and pushes the release
-  # commit. In an organisation that should be a dedicated devops account.
-  USER_NAME: jenstroeger
-  USER_EMAIL: jenstroeger@users.noreply.github.com
 
 jobs:
   check:
@@ -24,7 +17,7 @@ jobs:
     permissions:
       contents: read
     with:
-      disable_pip_audit: ${{ vars.DISABLE_PIP_AUDIT == 'true' }}
+      disable-pip-audit: ${{ vars.DISABLE_PIP_AUDIT == 'true' }}
 
   # On pushes to the 'main' branch create a new release by bumping the version
   # and generating a change log. That's the new bump commit and associated tag.
@@ -63,6 +56,11 @@ jobs:
         git config --global user.name "$USER_NAME"
         git config --global user.email "$USER_EMAIL"
         git config --list --global # For debug purposes.
+      env:
+        # This is the username and email for the user who commits and pushes the release
+        # commit. In an organisation that should be a dedicated devops account.
+        USER_NAME: jenstroeger
+        USER_EMAIL: jenstroeger@users.noreply.github.com
 
     # In some cases a user may merge commits that don't cause a version bump, which causes commitizen
     # to fail with error code 21 (NoneIncrementExit). Thus we silence that particular error to avoid
@@ -82,7 +80,7 @@ jobs:
     permissions:
       contents: read
     with:
-      disable_pip_audit: ${{ vars.DISABLE_PIP_AUDIT == 'true' }}
+      disable-pip-audit: ${{ vars.DISABLE_PIP_AUDIT == 'true' }}
 
   # Create a new Release on Github from the verified build artifacts, and optionally
   # publish the artifacts to a PyPI server.
@@ -111,7 +109,7 @@ jobs:
     - name: Download artifact
       uses: actions/download-artifact@9bc31d5ccc31df68ecc42ccf4149144866c47d8a # v3.0.2
       with:
-        name: ${{ env.ARTIFACT_NAME }}
+        name: artifact-ubuntu-latest-python-3.11
         path: dist
 
     # Verify hashes by first computing hashes for the artifacts and then comparing them
@@ -229,9 +227,9 @@ jobs:
     permissions:
       contents: read
     with:
-      repo_name: ${{ github.event.repository.name }}
-      release_tag: ${{ needs.release.outputs.release-tag }}
-      release_url: ${{ needs.release.outputs.release-url }}
+      repo-name: ${{ github.event.repository.name }}
+      release-tag: ${{ needs.release.outputs.release-tag }}
+      release-url: ${{ needs.release.outputs.release-url }}
     secrets:
       SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
 
@@ -245,14 +243,14 @@ jobs:
     permissions:
       contents: read
     with:
-      release_tag: ${{ needs.release.outputs.release-tag }}
-      release_url: ${{ needs.release.outputs.release-url }}
+      release-tag: ${{ needs.release.outputs.release-tag }}
+      release-url: ${{ needs.release.outputs.release-url }}
       # Github disallows passing environment variables as arguments to a reusable
       # workflow, so we have to duplicate these values here. Related discussion
       # here: https://github.com/actions/toolkit/issues/931
-      artifact_name: artifact-ubuntu-latest-python-3.11
-      git_user_name: jenstroeger
-      git_user_email: jenstroeger@users.noreply.github.com
+      artifact-name: artifact-ubuntu-latest-python-3.11
+      git-user-name: jenstroeger
+      git-user-email: jenstroeger@users.noreply.github.com
     secrets:
       REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}
 
@@ -267,9 +265,9 @@ jobs:
     permissions:
       contents: read
     with:
-      to_head: staging
-      from_base: origin/main
-      git_user_name: jenstroeger
-      git_user_email: jenstroeger@users.noreply.github.com
+      to-head: staging
+      from-base: origin/main
+      git-user-name: jenstroeger
+      git-user-email: jenstroeger@users.noreply.github.com
     secrets:
       REPO_ACCESS_TOKEN: ${{ secrets.REPO_ACCESS_TOKEN }}