Package versions with GitHub Releases
Package versions with GitHub Releases
A tag names a commit in Git. A GitHub Release adds a distribution page around that version with notes and optional downloadable assets.
What you’ll learn
- Relate tags to Releases.
- Create a release from a tag.
- Write useful release notes.
Version marker to distributable release
Git tag
Name a tested commit.
v1.0.0Release
Add notes and metadata.
GitHub ReleaseAssets
Optionally attach distributable files.
downloads
Release metadata sits on top of Git tags
GitHub Releases are based on Git tags. A release can include a title, description/release notes and attached binary assets. The release date and tag creation date can differ.
Use a consistent versioning policy and document breaking changes, migration steps and known limitations. Automated release notes can help summarize merged work, but review generated text before publishing.
Turn a tag into a hosted release
Run this in a disposable practice repository unless the lesson explicitly says otherwise.
git tag -a v1.0.0 -m "Version 1.0.0"
git push origin v1.0.0
# Optional GitHub CLI:
gh release create v1.0.0 --generate-notesThe tag exists in Git. The gh command creates GitHub release metadata around that tag; GitHub's web interface can do the same.
Practice: GitHub Releases
Your task: Draft release notes with sections for Highlights, Fixes, Upgrade notes and Known issues. Tie each item to a merged pull request or issue when useful.
Common pitfall to avoid
Do not retag a published version casually. Consumers may already depend on the original commit. Prefer a new version tag for corrected releases.
Check your understanding
GitHub Releases: what to remember
Package versions with GitHub Releases is complete when you can explain the state being changed before you run the command, not merely repeat the syntax.
Read further: official supporting documentation.
Reaching the recap and completing the quizzes are separate milestones.