diff options
author | Sean McGivern <sean@gitlab.com> | 2017-09-27 09:52:03 +0100 |
---|---|---|
committer | Sean McGivern <sean@gitlab.com> | 2017-09-27 09:52:03 +0100 |
commit | 3fba557d5c310e1fc4e6866a6a342c40331b3ad2 (patch) | |
tree | 093dfbe25bb23d27ae2ae8ad3487e90ee3fca368 /scripts | |
parent | 05d8e87dba4abaf9eb495bac147c4d4c5426da2e (diff) | |
download | gitlab-ce-3fba557d5c310e1fc4e6866a6a342c40331b3ad2.tar.gz |
Add static analysis job to find invalid YAML in changelogs
When a changelog has invalid YAML (typically, there is an unquoted @ at the
start of the author field), then the entry will be discarded. This script checks
all unreleased changelogs for validity, and runs as part of the static-analysis
step, so the pipeline will fail if this happens in future.
Diffstat (limited to 'scripts')
-rwxr-xr-x | scripts/lint-changelog-yaml | 19 | ||||
-rwxr-xr-x | scripts/static-analysis | 3 |
2 files changed, 21 insertions, 1 deletions
diff --git a/scripts/lint-changelog-yaml b/scripts/lint-changelog-yaml new file mode 100755 index 00000000000..402a0c42bd3 --- /dev/null +++ b/scripts/lint-changelog-yaml @@ -0,0 +1,19 @@ +#!/usr/bin/env ruby + +require 'yaml' + +invalid_changelogs = Dir['changelogs/**/*.yml'].reject do |changelog| + begin + YAML.load_file(changelog) + rescue + end +end + +if invalid_changelogs.any? + puts "Changelogs with invalid YAML found!\n" + puts invalid_changelogs.sort + exit 1 +else + puts "All changelogs are valid YAML.\n" + exit 0 +end diff --git a/scripts/static-analysis b/scripts/static-analysis index 295b6f132c1..aeefb2bc96f 100755 --- a/scripts/static-analysis +++ b/scripts/static-analysis @@ -13,7 +13,8 @@ tasks = [ %w[yarn run eslint], %w[bundle exec rubocop --require rubocop-rspec], %w[scripts/lint-conflicts.sh], - %w[bundle exec rake gettext:lint] + %w[bundle exec rake gettext:lint], + %w[scripts/lint-changelog-yaml] ] failed_tasks = tasks.reduce({}) do |failures, task| |