GHA: Wait for gitlint package to be available after publish (#434)

It takes a short time for packages to show up on PyPI after publishing.

Wait for the gitlint package to show up before starting the post-release
test run by trying to install the gitlint package, and retrying after a
timeout until the package is available.

Author: jorisroovers

.github/workflows/publish-release.yml

@@ -96,9 +96,38 @@ jobs:
           HATCH_INDEX_AUTH: ${{ secrets.TEST_PYPI_GITLINT_PASSWORD }}
         if: inputs.pypi_target == 'test.pypi.org' && inputs.repo_release_ref == 'main'
 
-  test_release:
+  # Wait for gitlint package to be available in PyPI for installation
+  wait-for-package:
     needs:
       - publish
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: Install gitlint
+        uses: nick-fields/[email protected]
+        with:
+          timeout_minutes: 1
+          max_attempts: 10
+          command: |
+            python -m pip install gitlint==${{ needs.publish.outputs.gitlint_version }}
+        if: inputs.pypi_target == 'pypi.org'
+
+      - name: Install gitlint (test.pypi.org)
+        uses: nick-fields/[email protected]
+        with:
+          timeout_minutes: 1
+          max_attempts: 10
+          command: |
+            pip install --no-cache -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple gitlint==${{ needs.publish.outputs.gitlint_version }}
+        if: inputs.pypi_target == 'test.pypi.org'
+
+      - name: gitlint --version
+        run: |
+          gitlint --version
+          [ "$(gitlint --version)" == "gitlint, version ${{ needs.publish.outputs.gitlint_version }}" ]
+
+  test-release:
+    needs:
+      - wait-for-package
     uses: ./.github/workflows/test-release.yml
     with:
       gitlint_version: ${{ needs.publish.outputs.gitlint_version }}

.github/workflows/test-release.yml

@@ -35,7 +35,7 @@ on:
         default: "main"
 
 jobs:
-  checks:
+  test-release:
     timeout-minutes: 10
     runs-on: "ubuntu-latest"
     strategy:
@@ -48,8 +48,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
 
-      # Intentionally install hatch before gitlint, to buy us a few extra seconds in case the gitlint package was just
-      # published and hasn't appeared on PyPI yet.
       - name: Install Hatch
         run: python -m pip install hatch==1.6.3