maxmustermann/gitlab
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Docs: Refine changelog's README

Browse source 
Mention how changelogs are generated nowadays.
This commit is contained in:
Peter Leitzen 2021-09-07 16:57:02 +02:00
parent 49aa4cc420
commit 0d83b3b80a
No known key found for this signature in database
GPG key ID: 97DE9D2E708A225E
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
changelogs/README.md
View file

@ -1,13 +1,11 @@
# Generating changelog entries
To generate and validate your changelog entries:
From GitLab 14.0.0 onwards, [CHANGELOG.md](../CHANGELOG.md) is generated
by parsing [Git trailers](https://git-scm.com/docs/git-interpret-trailers)
in commit messages.
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
See [documentation](https://docs.gitlab.com/ee/development/changelog.html#how-to-generate-a-changelog-entry)
on how to generate changelog entries.
# Changelog archival