only allow one draft at a time, and update it if it is the target version

A limitation of the release-drafter (as I understand it) is that it
only updates the latest draft, whether it is the dev draft at that
point or the release draft, hence, resulting in duplicate release
drafts if a PR against a release branch is merged.

Here, we've added a step that checks and expects only 1 draft release
at a time. This is cleaner because: while the only draft is `dev`,
we only update that draft. Once, during the release process, `dev`
becomes a `release_` branch, we do not create yet another draft
for dev and instead just update the latest release branch draft,
until the release will be published and then dev will start getting
its own draft notes.
This commit is contained in:
Ahmed Awan
2025-12-16 21:29:41 +05:00
parent a05abd0ff2
commit 19486b79fe
+29
View File
@@ -35,7 +35,36 @@ jobs:
echo "version=${RELEASE_VERSION}" >> $GITHUB_OUTPUT
echo "Galaxy release version: ${RELEASE_VERSION}"
- name: Check if we should update draft
id: check-draft
run: |
VERSION="${{ inputs.version || steps.galaxy-version.outputs.version }}"
# Check if this version is already published
PUBLISHED=$(gh release view "v${VERSION}" --json isDraft --jq '.isDraft' 2>/dev/null || echo "not_found")
if [ "$PUBLISHED" = "false" ]; then
echo "Published release v${VERSION} already exists. Skipping."
echo "skip=true" >> $GITHUB_OUTPUT
exit 0
fi
# Check if a draft exists for a DIFFERENT version (only one draft at a time)
EXISTING_DRAFT=$(gh release list --limit 50 --json tagName,isDraft --jq '.[] | select(.isDraft == true) | .tagName' | head -1)
if [ -n "$EXISTING_DRAFT" ] && [ "$EXISTING_DRAFT" != "v${VERSION}" ]; then
echo "Draft release $EXISTING_DRAFT already exists (for different version). Skipping v${VERSION}."
echo "Only one draft release at a time is supported."
echo "skip=true" >> $GITHUB_OUTPUT
else
echo "Proceeding with draft for v${VERSION}."
echo "skip=false" >> $GITHUB_OUTPUT
fi
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: release-drafter/release-drafter@v6
if: steps.check-draft.outputs.skip == 'false'
with:
config-name: release-drafter.yml
version: ${{ steps.galaxy-version.outputs.version }}