luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

ci: make changelog-checker only validate PR number against main base (#10844)

This commit is contained in:
Mike Morris 2021-08-16 15:40:51 -04:00 committed by GitHub
parent 4cad5b8a04
commit c5975b5dfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.changelog/10844.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:improvement
ci: make changelog-checker only validate PR number against main base
```

14
.github/workflows/changelog-checker.yml vendored
View File

@ -23,13 +23,23 @@ jobs:
fetch-depth: 0 # by default the checkout action doesn't checkout all branches fetch-depth: 0 # by default the checkout action doesn't checkout all branches
- name: Check for changelog entry in diff - name: Check for changelog entry in diff
run: | run: |
pull_request_base_main=$(expr "${{ github.event.pull_request.base.ref }}" = "main")
# check if there is a diff in the .changelog directory # check if there is a diff in the .changelog directory
changelog_files=$(git --no-pager diff --name-only HEAD "$(git merge-base HEAD "origin/${{ github.event.pull_request.base.ref }}")" -- .changelog/${{ github.event.pull_request.number }}.txt) # for PRs against the main branch, the changelog file name should match the PR number
if [ pull_request_base_main ]; then
enforce_matching_pull_request_number="matching this PR number "
changelog_file_path=".changelog/${{ github.event.pull_request.number }}.txt"
else
changelog_file_path=".changelog/*.txt"
fi
changelog_files=$(git --no-pager diff --name-only HEAD "$(git merge-base HEAD "origin/main")" -- ${changelog_file_path})
# If we do not find a file in .changelog/, we fail the check # If we do not find a file in .changelog/, we fail the check
if [ -z "$changelog_files" ]; then if [ -z "$changelog_files" ]; then
# Fail status check when no .changelog entry was found on the PR # Fail status check when no .changelog entry was found on the PR
echo "Did not find a .changelog entry and the 'pr/no-changelog' label was not applied. Reference - https://github.com/hashicorp/consul/pull/8387" echo "Did not find a .changelog entry ${enforce_matching_pull_request_number}and the 'pr/no-changelog' label was not applied. Reference - https://github.com/hashicorp/consul/pull/8387"
exit 1 exit 1
else else
echo "Found .changelog entry in PR!" echo "Found .changelog entry in PR!"