Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add action to check if changelog was updated #1485

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add action to check if changelog was updated #1485

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b208c8
Add action to check if changelog was updated
carson-katri Nov 13, 2024
8ef8fc7
Attempt to fix YAML
carson-katri Nov 13, 2024
117a5c5
Attempt to fix YAML
carson-katri Nov 13, 2024
1f64b41
Quote command
carson-katri Nov 13, 2024
b643ae2
Update changelog
carson-katri Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/changelog_updated.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Changelog Updated

on:
pull_request:
branches:
- main

jobs:
changelog_updated:
name: Changelog Updated
runs-on: ubuntu-20.04
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 2
- name: Check if CHANGELOG.md was changed
run: "! git diff --name-only --exit-code HEAD^1 HEAD CHANGELOG.md"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is needed as not every PR will affect public API

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can make it so that it doesn't block merging, but still works as a reminder to update the changelog.

1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [unreleased]

### Added
- Added GitHub Action for checking if the changelog was updated.

### Changed

Expand Down
Loading