From 60cf783f90f841a54deb4ce5484e3f6d96e91051 Mon Sep 17 00:00:00 2001 From: Jarry Shaw Date: Tue, 27 Oct 2026 06:04:10 -0400 Subject: [PATCH] docs(ci): correct create-release's github job comment about the tag job (#2329) Problem: the comment above the `github` job's "Check the release tags name this run's commit" step claimed `tag` makes the same check via that step. `pypi` and `conda` do; `tag` has no such step -- its "Create Tag" step makes the equivalent comparison inline with `git rev-parse` on the tags its own checkout fetched, without `release_tags.resolve`'s fetch of the tag. Fix: reword the comment to name only `pypi` and `conda` as running the step, and describe what `tag` actually does instead. --- .github/workflows/create-release.yml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/create-release.yml b/.github/workflows/create-release.yml index 534d205acb..fd5acb3dd6 100644 --- a/.github/workflows/create-release.yml +++ b/.github/workflows/create-release.yml @@ -446,9 +446,12 @@ jobs: # ``action.yml``), so no ``env:`` names one. token: ${{ steps.app_token.outputs.token || secrets.GITHUB_TOKEN }} - # #1634: the same check ``tag``, ``pypi`` and ``conda`` make before they - # publish under this tag. Here it catches the tag having existed already - # at another commit, which ``action-gh-release`` silently reuses. + # #1634: the same check ``pypi`` and ``conda`` make before they publish + # under this tag. ``tag`` has no such step: its "Create Tag" makes the + # equivalent comparison inline, ``git rev-parse`` on the tags its own + # checkout fetched, without ``release_tags.resolve``'s fetch of the tag. + # Here the check catches the tag having existed already at another commit, which + # ``action-gh-release`` silently reuses. - name: Check the release tags name this run's commit env: PCAPKIT_TAGS: v${{ needs.version_check.outputs.PCAPKIT_VERSION }}