docs: added changelog - #188
Open
saberzero1 wants to merge 1 commit into
Open
saberzero1 wants to merge 1 commit into
saberzero1 wants to merge 1 commit into
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
Comment on lines
+9
to
+24
| name: Changelog updated | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
|
||
| - name: Check for CHANGELOG.md changes | ||
| uses: dangoslen/changelog-enforcer@v3 | ||
| with: | ||
| changeLogPath: CHANGELOG.md | ||
| skipLabels: "skip-changelog" | ||
| missingUpdateErrorMessage: > | ||
| Please add a changelog entry to CHANGELOG.md under the | ||
| `## [Unreleased]` section. | ||
| Follow [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) conventions. | ||
| If this change does not need a changelog entry, add the `skip-changelog` label. |
There was a problem hiding this comment.
Pull request overview
Adds a project changelog and introduces an automated GitHub Actions check to enforce that future pull requests include a changelog update (or an explicit skip label), aligning the repo with Keep a Changelog conventions.
Changes:
- Added a new
CHANGELOG.mdfollowing Keep a Changelog structure and backfilled entries for existing releases. - Added a “Changelog” GitHub Actions workflow to require
CHANGELOG.mdupdates on PRs tomaster(unless labeledskip-changelog).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CHANGELOG.md | Introduces a Keep a Changelog-formatted changelog with release history and comparison links. |
| .github/workflows/changelog.yml | Adds a PR check using dangoslen/changelog-enforcer to require changelog updates (or a skip label). |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes #185