Skip to content

fix(release): one GitHub release step, not two #46

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gierschv merged 1 commit into from
Sep 11, 2026
+4 −21
Merged

fix(release): one GitHub release step, not two #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 4 additions & 21 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,37 +71,20 @@ jobs:
env:
GH_TOKEN: ${{ github.token }}
run: |
# Every tag in this repository, and in api-reference, carries the v. The version
# inside the package never does, so the tag is compared with it stripped.
TAG="${GITHUB_REF_NAME#v}"
NOTES="$(awk -v tag="$TAG" '
$0 ~ "^## \\[?" tag {found=1; next}
found && /^## / {exit}
found {print}
' CHANGELOG.md)"
[ -n "$NOTES" ] || NOTES="See CHANGELOG.md for the changes in $TAG."
printf '%s\n\n---\n\nInstall: `pip install flat-api==%s`\n' "$NOTES" "$TAG" \
> /tmp/notes.md
gh release create "$TAG" --title "$TAG" --notes-file /tmp/notes.md --verify-tag

# The tag alone left the repository's Releases page showing a version from years ago as
# "Latest", which is what anyone browsing the repository sees first. The notes come from the
# CHANGELOG section for this version, so the release says what changed rather than nothing.
- name: Publish the GitHub release
env:
GH_TOKEN: ${{ github.token }}
run: |
# The release is named for the tag. The version inside the package never carries the v,
# so the changelog lookup and the install line use it stripped.
VERSION="${GITHUB_REF_NAME#v}"
NOTES="$(awk -v v="$VERSION" '
$0 ~ "^## \\[?" v "\\]?" { found = 1; next }
found && /^## / { exit }
found { print }
' CHANGELOG.md)"
[ -n "$NOTES" ] || NOTES="See CHANGELOG.md for $VERSION."
printf '%s\n\n---\n\nInstall: `pip install flat-api==%s`\n' "$NOTES" "$VERSION" > /tmp/notes.md
# Creating one that exists is an error, and a re-run of a release that already happened
# should be a no-op rather than a red build.
if gh release view "$GITHUB_REF_NAME" >/dev/null 2>&1; then
echo "Release $GITHUB_REF_NAME already exists; nothing to do."
else
gh release create "$GITHUB_REF_NAME" --title "$GITHUB_REF_NAME" --notes "$NOTES"
gh release create "$GITHUB_REF_NAME" --title "$GITHUB_REF_NAME" --notes-file /tmp/notes.md --verify-tag
fi
Loading