changelog
/ˈtʃeɪndʒˌlɒɡ/noun
A changelog is a record of relevant software changes, usually organized by version or release. It includes new features, bug fixes and changes that affect users.
The changelog states that this release includes a new search filter and two bug fixes.
A changelog helps users, developers and administrators see what has changed in software. It is often kept in a file alongside the source code or on a public page. For each Glossary · In briefreleaseA release is an identifiable software version prepared to be made available to users. It brings together one or more checked changes.Read more, it describes the changes that matter to its readers.
What goes into a changelog?
A changelog usually groups changes by version number and publication date. Within each version, it may list new features, improvements, bug fixes, security updates and removed features separately. A major change should also explain what users or administrators need to adjust.
The level of detail depends on the audience. Users mainly need to know about visible changes. Developers also need to know whether an Glossary · In briefAPIAn API is a defined way for software to exchange data or call functions in other software without needing to know how that software works internally.Read more, configuration or Glossary · In briefdatabaseA database is a structured collection of data that software can store, retrieve and modify. A database management system controls access to that data.Read more has changed. A changelog need not include every technical step, but should explain the consequences of a new version.
Changelogs and Git history
The history in version control consists of individual Glossary · In briefcommitA commit is a recorded version of files in a version control system. Each commit marks a point in a project's development history.Read more. Their messages record technical steps and may include intermediate work, corrections and internal details. A changelog summarizes the relevant outcome in accessible language, usually for each release.
Release notes are similar to changelogs, and the terms are sometimes used interchangeably. Release notes often provide more context for one particular release, while a changelog maintains a consistent record across several versions. Both help connect a Glossary · In briefdeploymentA deployment is the process of installing and starting a chosen software version in a target environment so it can be tested or used there.Read more to the changes users see.