summaryrefslogtreecommitdiff
path: root/changelogs/README.md
blob: 3dad62474a28a1748ab21519f05a3e39b1a005de (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Generating changelog entries

To generate and validate your changelog entries:

1. Run `bin/changelog` to generate.
1. Run `yamllint changelogs` to validate.

See [development/changelog] documentation for detailed usage.

[development/changelog]: https://docs.gitlab.com/ee/development/changelog.html

# 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).