changelog
A file or page listing the notable changes in each release of a project, newest first.
In more detail
A changelog is written for users, so it groups changes as features, fixes and breaking changes rather than listing every commit. Some projects generate it from structured commit messages such as Conventional Commits.
Examples
Changesets writes changelog entries from the per-change files at release time.In Terraform: Read a module's or provider's changelog before upgrading it. When you publish a module, record each release's changes and migration steps there.Related terms
- Changesets — A tool where each pull request adds a small Markdown file describing its change and its version bump, later combined into releases and changelogs.
- semantic versioning — A version numbering scheme of three numbers, major.minor.patch, raised for breaking changes, new features and fixes respectively.
- release notes — A human-readable summary of what changed in a release: new features, fixes and anything users must do differently.
- 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.
- breaking change — A change that makes existing users of a program or interface stop working until they change something too.
- public module — A reusable module published to the Terraform Registry, called by an address such as terraform-aws-modules/vpc/aws.
Taught in
- System Governance: Changesets, Semantic Versioning & Deprecation — Design Systems & Component Engineering
- Committing, And What A Good Message Says — Advanced Git Internals & Distributed Workflows
- Tags And Releases — Advanced Git Internals & Distributed Workflows
- The Terraform Registry And Public Modules — Infrastructure as Code with Terraform
- Versioning And Pinning Modules — Infrastructure as Code with Terraform
- Module Versions: Pin, Upgrade, Re-Initialise — HashiCorp Terraform Associate (004) Exam Prep
- What Changed Last Night? Integrity, Scans, Benchmarks And Secure Deletion — CompTIA Linux+ (XK0-006) Exam Prep
- Patched On Paper: Missing Updates, Broken Chains, Old Protocols And Open Doors — CompTIA Linux+ (XK0-006) Exam Prep