Skip to content

Commit

Permalink
Rename changelog references to release notes (#190)
Browse files Browse the repository at this point in the history
All other references are release note so let's keep it consistent to
avoid confusion.
  • Loading branch information
Kyle-Verhoog committed Aug 27, 2024
1 parent 3775b95 commit c5006aa
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
name: Changelog
name: Release notes
on:
push:
branches:
- master
pull_request:
# Important that we run on `labeled` and `unlabeled` to pick up `changelog/no-changelog` being added/removed
# Important that we run on `labeled` and `unlabeled` to pick up `no-releasenote` being added/removed
# DEV: [opened, reopened, synchronize] is the default
types: [opened, reopened, synchronize, labeled, unlabeled, ready_for_review]
jobs:
validate:
name: Validate changelog
name: Validate release notes
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
Expand All @@ -18,12 +18,12 @@ jobs:
fetch-depth: 0

# Ensure a new reno release note was added in this PR.
# Use `reno new <slug>` to add a new note to `releasenotes/notes`,
# or add `changelog/no-changelog` label if no release note is needed.
# Use `reno new <slug>` to add a new note to `no-releasenote`,
# or add `no-releasenote` label if no release note is needed.
- name: Ensure release note added
# Only run this on pull requests
if: github.event_name == 'pull_request'
run: scripts/check-releasenotes
run: releasenotes/check-releasenotes

- uses: actions/setup-python@v2
name: Install Python
Expand All @@ -33,5 +33,5 @@ jobs:
- name: Install Dependencies
run: pip install reno docutils

- name: Lint changelog notes
- name: Lint release notes
run: reno lint
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ echo "JQ: $(which jq)"


# Skip the label check if we do not have a GitHub event path
if [[ -f "${GITHUB_EVENT_PATH}" ]] && jq -e '.pull_request?.labels[]?.name | select(. == "no-changelog")' "${GITHUB_EVENT_PATH}";
if [[ -f "${GITHUB_EVENT_PATH}" ]] && jq -e '.pull_request?.labels[]?.name | select(. == "no-releasenote")' "${GITHUB_EVENT_PATH}";
then
echo "PR has label 'no-changelog', skipping validation"
echo "PR has label 'no-releasenote', skipping validation"
exit 0
fi

Expand All @@ -24,6 +24,6 @@ then
exit 0
else
echo "Release note not found."
echo "Use 'reno new <slug>' to add a new note to 'releasenotes/notes', or add the label 'no-changelog' to skip this validation"
echo "Use 'reno new <slug>' to add a new note to 'releasenotes/notes', or add the label 'no-releasenote' to skip this validation"
exit 1
fi

0 comments on commit c5006aa

Please sign in to comment.