release notes
A human-readable summary of what changed in a release: new features, fixes and anything users must do differently.
In more detail
They are written for users rather than developers and grouped into new features, fixes and breaking changes. Many tools can draft them from merged pull requests or structured commit messages.
Example
GitHub can generate release notes for a GitHub Release.Related terms
- semantic versioning — A version numbering scheme of three numbers, major.minor.patch, raised for breaking changes, new features and fixes respectively.
- release — Making a version of software, or one of its behaviours, available to users; also the versioned package being made available.
- changelog — A file or page listing the notable changes in each release of a project, newest first.
- GitHub Releases — A GitHub feature that turns a Git tag into a release page with notes and downloadable files.
- Conventional Commits — A specification for commit subject lines of the form type(optional scope): description, so tools can read what kind of change each commit is.
Taught in
- Building And Versioning The Artifact — DevOps & Site Reliability Engineering
- Committing, And What A Good Message Says — Advanced Git Internals & Distributed Workflows
- Conventional Commits — Advanced Git Internals & Distributed Workflows
- Tags And Releases — Advanced Git Internals & Distributed Workflows