Skip to content

Commit d08182e

Browse files
palukkuGuilhermeRibeiroPereira
authored andcommitted
workflow added for detecting changelog modification (JabRef#12783)
1 parent 3b90b3a commit d08182e

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

.github/ghprcomment.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,7 @@
111111
112112
You can then run these tests in IntelliJ to reproduce the failing tests locally.
113113
We offer a quick test running howto in the section [Final build system checks](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html#final-build-system-checks) in our setup guide.
114+
- jobName: 'CHANGELOG.md was modified'
115+
message: >
116+
If you made changes that are visible to the user, please add a brief description along with the issue number to the `CHANGELOG.md` file.
117+
More details can be found in our [Developer Documentation about the changelog](https://devdocs.jabref.org/decisions/0007-human-readable-changelog.html).

.github/workflows/tests.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,3 +436,22 @@ jobs:
436436
with:
437437
name: pr_number
438438
path: pr_number.txt
439+
440+
changelog_modified:
441+
name: CHANGELOG.md was modified
442+
if: github.actor != 'dependabot[bot]' && github.event_name == 'pull_request'
443+
runs-on: ubuntu-latest
444+
steps:
445+
- uses: actions/checkout@v4
446+
with:
447+
fetch-depth: 0
448+
- name: Check for CHANGELOG.md modifications
449+
id: check_changelog_modification
450+
run: |
451+
git fetch origin ${{ github.base_ref }}
452+
if git diff --name-only origin/${{ github.base_ref }}...HEAD | grep -q '^CHANGELOG\.md$'; then
453+
echo "✅ CHANGELOG.md was modified"
454+
else
455+
echo "❌ CHANGELOG.md was NOT modified"
456+
exit 1
457+
fi

0 commit comments

Comments
 (0)