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.

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

Make change log entries mandatory with every PR #988

Merged
merged 12 commits into from
Nov 21, 2024
26 changes: 26 additions & 0 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: "Changelog Updated"
on:
pull_request:
# The specific activity types are listed here to include "labeled" and "unlabeled"
# (which are not included by default for the "pull_request" trigger).
# This is needed to allow skipping enforcement of the changelog in PRs with specific labels,
# as defined in the (optional) "skipLabels" property.
types: [opened, synchronize, reopened, ready_for_review, labeled, unlabeled]

jobs:
# Enforces the update of a changelog file on every pull request.
changelog:
runs-on: ubuntu-latest
steps:
# CHANGELOG.md
- uses: dangoslen/changelog-enforcer@v3
with:
skipLabels: 'Skip Changelog'
versionPattern: '## \\[((v|V)?\\d*\\.\\d*\\.\\d*-?\\w*|unreleased|Unreleased|UNRELEASED|Dev)\\]'

# readme.txt
- uses: dangoslen/changelog-enforcer@v3
with:
changeLogPath: 'readme.txt'
skipLabels: 'Skip Changelog'
versionPattern: '^=\\s*((v|V)?\\d+\\.\\d+\\.\\d+|Dev)\\s*='
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* Unit tests for the `ActivityPub\Transformer\Post` class

### Added

* GitHub action to enforce Changelog updates.

### Improved

* Reuse constants once they're defined
Expand Down
4 changes: 4 additions & 0 deletions readme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,10 @@ For reasons of data protection, it is not possible to see the followers of other

== Changelog ==

= Dev =

* Added: GitHub action to enforce Changelog updates.

= 4.2.1 =

* Added: Mastodon Apps status provider
Expand Down
Loading