This repository has been archived by the owner on Mar 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: add changelog-checker from Consul core
- Loading branch information
1 parent
f639ef5
commit 644f6f9
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# This workflow checks that there is either a 'pr/no-changelog' label applied to a PR | ||
# or there is a .changelog/<pr number>.txt file associated with a PR for a changelog entry | ||
|
||
on: | ||
pull_request: | ||
types: [opened, synchronize, labeled] | ||
# Runs on PRs to main and all release branches | ||
branches: | ||
- main | ||
- release/* | ||
|
||
jobs: | ||
# checks that a .changelog entry is present for a PR | ||
changelog-check: | ||
# If there a `pr/no-changelog` label we ignore this check | ||
if: "!contains(github.event.pull_request.labels.*.name, 'pr/no-changelog')" | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
with: | ||
ref: ${{ github.event.pull_request.head.sha }} | ||
fetch-depth: 0 # by default the checkout action doesn't checkout all branches | ||
- name: Check for changelog entry in diff | ||
run: | | ||
pull_request_base_main=$(expr "${{ github.event.pull_request.base.ref }}" = "main") | ||
# check if there is a diff in the .changelog directory | ||
# 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 [ -z "$changelog_files" ]; then | ||
# Fail status check when no .changelog entry was found on the PR | ||
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 | ||
else | ||
echo "Found .changelog entry in PR!" | ||
fi |