diff options
| author | Elan Ruusamäe <glen@delfi.ee> | 2019-02-18 07:57:57 +0300 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-02-18 07:57:57 +0300 |
| commit | 83b1c44a7704637b54eaa815ec8d8a2d4aa36884 (patch) | |
| tree | d08e61043177443669abc6bf1d1bf6195634391e | |
| parent | 1cd080c71afb4bb04cf786821b864278098bad03 (diff) | |
add changelogs/README.md
this is to quickstart contributors who don't work daily on the codebase
| -rw-r--r-- | changelogs/README.md | 10 | ||||
| -rw-r--r-- | changelogs/unreleased/changelogs-readme.yml | 5 | ||||
| -rwxr-xr-x | scripts/lint-changelog-yaml | 2 |
3 files changed, 16 insertions, 1 deletions
diff --git a/changelogs/README.md b/changelogs/README.md new file mode 100644 index 00000000000..c4113ccb863 --- /dev/null +++ b/changelogs/README.md @@ -0,0 +1,10 @@ +# Generating changelog entries + +To generate and validate your changelog entries: + +1. Run `bin/changelog` to generate. +1. Run `scripts/lint-changelog-yaml` to validate. + +See [development/changelog] documentation for detailed usage. + +[development/changelog]: https://docs.gitlab.com/ee/development/changelog.html diff --git a/changelogs/unreleased/changelogs-readme.yml b/changelogs/unreleased/changelogs-readme.yml new file mode 100644 index 00000000000..9f391699575 --- /dev/null +++ b/changelogs/unreleased/changelogs-readme.yml @@ -0,0 +1,5 @@ +--- +title: add readme to changelogs directory +merge_request: 25209 +author: "@glensc" +type: added diff --git a/scripts/lint-changelog-yaml b/scripts/lint-changelog-yaml index 6553e02ffca..06d502c4676 100755 --- a/scripts/lint-changelog-yaml +++ b/scripts/lint-changelog-yaml @@ -3,7 +3,7 @@ require 'yaml' invalid_changelogs = Dir['changelogs/**/*'].reject do |changelog| - next true if changelog =~ /(archive\.md|unreleased(-ee)?)$/ + next true if changelog =~ /((README|archive)\.md|unreleased(-ee)?)$/ next false unless changelog.end_with?('.yml') begin |