Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
51 changes: 51 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Changelog Check

on:
pull_request:
branches:
- main # adjust to your default branch

jobs:
changelog:
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write # Needed to post comments
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Needed for diff mode

- name: Validate Changelog
id: changelog-check
uses: ./changelog-check
with:
check-mode: diff
base-ref: ${{ github.event.pull_request.base.ref }}

- name: Find existing changelog comment
if: always() # Run regardless of breaking change status
uses: peter-evans/find-comment@v4
id: find-comment
with:
issue-number: ${{ github.event.pull_request.number }}
body-includes: "<!-- changelog-breaking-changes -->"

- name: Comment on breaking changes
if: always() # Run regardless of breaking change status
uses: peter-evans/create-or-update-comment@v5
with:
issue-number: ${{ github.event.pull_request.number }}
comment-id: ${{ steps.find-comment.outputs.comment-id }}
edit-mode: replace
body: |
<!-- changelog-breaking-changes -->
${{ steps.changelog-check.outputs.has_breaking == 'true' &&
'**This PR contains breaking changes.** Please ensure this is intentional and properly documented.' ||
'No breaking changes detected.' }}

- name: Fail if invalid
if: steps.changelog-check.outputs.is_valid != 'true'
run: |
echo "::error::CHANGELOG validation failed. Please fix the CHANGELOG.md format."
exit 1
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,16 @@ Breaking changes are prefixed with "Breaking Change: ".
and detects breaking changes.
- `autotag-from-changelog` action: tag and push from CHANGELOG.md version
change.

### Removed

- Removed something to check workflow

## [1.0.0] - 2026-03-06

### Added

- CHANGELOG.md and backfilled tags and changes.
- Egress private endpoint management commands
- Cluster disruption simulation commands
- Physical replication stream management commands
2 changes: 1 addition & 1 deletion changelog-check/check_breaking_changes.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ unreleased_content="${UNRELEASED_CONTENT:-}"
if [ "$check_mode" = "diff" ] && [ -n "$base_ref" ]; then
log_notice "Diff mode: checking changelog changes only"
# Get diff, filter to additions, remove file header, strip leading +
text_to_check=$(git diff "$base_ref" HEAD -- "$changelog" | grep "^+" | grep --invert-match "^+++" | sed 's/^+//')
text_to_check=$(git diff "origin/$base_ref" HEAD -- "$changelog" | grep "^+" | grep --invert-match "^+++" | sed 's/^+//')
else
log_notice "Checking entire Unreleased section"
# Use the Unreleased section content from mindsers action
Expand Down
Loading