Skip to content
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

Jump to bottom

Add job to create a GitHub release #8248

Merged
merged 3 commits into from
May 16, 2024
Merged

Add job to create a GitHub release #8248

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b75cb32
Add job to create a GitHub release
dlarocque May 14, 2024
52cbd72
Add release notes link and header to beginning of release notes
dlarocque May 15, 2024
37ccc60
Add link to release notes and custom header
dlarocque May 16, 2024
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: 25 additions & 0 deletions .github/workflows/release-prod.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,28 @@ jobs:
curl -X POST -H "Content-Type:application/json" \
-d "{\"version\":\"$BASE_VERSION\",\"date\":\"$DATE\"}" \
$RELEASE_TRACKER_URL/logProduction
- name: Create Github release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Get the newest release tag for the firebase package (e.g. [email protected])
NEWEST_TAG=$(git describe --tags --match "firebase@[0-9]*.[0-9]*.[0-9]*" --abbrev=0)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice use of --match to solve this problem.

# Get the release notes from the description of the most recent merged PR into the "release" branch
# See: https://github.com/firebase/firebase-js-sdk/pull/8236 for an example description
RELEASE_NOTES=$(gh pr list \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Were we going to add in some text to say "For more detailed release notes, see Firebase JavaScript SDK Release Notes."? You might want to test if you have to escape any of those markdown linking characters.

Changesets are better than commits but I think release notes may have more info than changesets.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done. Here's an example release with the new release notes: https://github.com/dlarocque/firebase-js-sdk/releases/tag/firebase%405.5.5

--repo "$GITHUB_REPOSITORY" \
--state "merged" \
--base "release" \
--limit 1 \
--json "body" \
| jq '.[].body'\
| jq -r . \
| sed '1,/^# Releases/d')
# Create the GitHub release
gh release create "$NEWEST_TAG" \
--repo="$GITHUB_REPOSITORY" \
--title="$NEWEST_TAG" \
--notes "$RELEASE_NOTES" \
--verify-tag
Loading