2019-02-17 23:57:57 -05:00
|
|
|
# Generating changelog entries
|
|
|
|
|
|
|
|
|
|
To generate and validate your changelog entries:
|
|
|
|
|
|
|
|
|
|
1. Run `bin/changelog` to generate.
|
2019-07-23 08:23:51 -04:00
|
|
|
1. Run `yamllint changelogs` to validate.
|
2019-02-17 23:57:57 -05:00
|
|
|
|
|
|
|
|
See [development/changelog] documentation for detailed usage.
|
|
|
|
|
|
|
|
|
|
[development/changelog]: https://docs.gitlab.com/ee/development/changelog.html
|
2020-09-03 11:08:29 -04:00
|
|
|
|
|
|
|
|
# Changelog archival
|
|
|
|
|
|
|
|
|
|
The current major release is always in [CHANGELOG.md](../CHANGELOG.md) at the
|
|
|
|
|
root of the repository.
|
|
|
|
|
|
|
|
|
|
From GitLab 10.0.0 onwards, we store all changelog entries for a major release
|
|
|
|
|
in their own file in this directory. For instance, the changelog entries for the
|
|
|
|
|
10.X series of GitLab are in [archive-10.md](archive-10.md). Releases prior to
|
|
|
|
|
10.0.0 have their changelogs archived in [archive.md](archive.md).
|
|
|
|
|
|
|
|
|
|
Changelogs for GitLab Enterprise Edition features (all tiers) are in the
|
|
|
|
|
corresponding `-ee` files, such as [CHANGELOG-EE.md](../CHANGELOG-EE.md) and
|
|
|
|
|
[archive-12-ee.md](archive-12-ee.md).
|
