wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update the changelog entry checker script to check newsfragment file extension (#1542)

Browse source
This commit is contained in:
Andrew Morgan 2023-05-31 11:30:51 +01:00 • committed by GitHub
parent dd6af5bfb1
commit c64a616d54
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/internal/newsfragments/1542.clarification Normal file
View file

@ -0,0 +1 @@
Update the CI to validate the file extension of changelog entries.

7
scripts/check-newsfragments
View file

@ -21,6 +21,12 @@ matched=0
while read f; do
basename=$(basename $f)
dirname=$(dirname $f)
extension="${f##*.}"
# check that each changelog file has a known extension
if ! [[ "$extension" == "new" || "$extension" == "feature" || "$extension" == "clarification" || "$extension" == "breaking" || "$extension" == "deprecation" ]]; then
echo -e "\e[31mERROR: newsfragment $f does not have one of the required file extensions for a changelog entry: .new, .feature, .clarification, .breaking, .deprecation\e[39m" >&2
fi
# check that there is nothing that looks like a newsfile outside one of the
# expected directories.
@ -31,6 +37,7 @@ while read f; do
# see if this newsfile corresponds to the right PR
[[ -n "$pr" && "$basename" == "$pr".* ]] && matched=1
fi
# find all files in the 'changelogs/*/' dirs that are in the form `<digits>.<text>`
done < <(find changelogs -regex '.*/[0-9]+\.[^/]+$')
if [[ -n "$pr" && "$matched" -eq 0 ]]; then