Skip to content

Commit d5c2c7e

Browse files
committed
address review: pin towncrier version, add draft preview step
- Pin towncrier==25.8.0 for repeatability (per @aabmass) - Add preview step to print rendered changelog in CI (per @emdneto) - Fix error messages to reference CONTRIBUTING.md Assisted-by: Claude Opus 4.6
1 parent b9306e7 commit d5c2c7e

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

.github/workflows/changelog.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,28 +34,27 @@ jobs:
3434
then
3535
echo "CHANGELOG.md should not be directly modified."
3636
echo "Please add a changelog fragment file to the .changelog/ directory instead."
37-
echo ""
38-
echo "Create a fragment with:"
39-
echo " tox -e new-changelog -- ${{ github.event.pull_request.number }} TYPE \"Description\""
40-
echo "where TYPE is one of: added, changed, deprecated, removed, fixed"
37+
echo "See CONTRIBUTING.md for details."
4138
echo ""
4239
echo "Or add the \"Skip Changelog\" label if this job should be skipped."
4340
false
4441
fi
4542
4643
- name: Install towncrier
47-
run: pip install towncrier
44+
run: pip install towncrier==25.8.0
4845

4946
- name: Check for changelog fragment
5047
run: |
5148
if ! towncrier check --compare-with origin/${{ github.base_ref }}; then
5249
echo ""
5350
echo "No changelog fragment found for this PR."
54-
echo ""
55-
echo "Create a fragment with:"
56-
echo " tox -e new-changelog -- ${{ github.event.pull_request.number }} TYPE \"Description\""
57-
echo "where TYPE is one of: added, changed, deprecated, removed, fixed"
51+
echo "Add a file named .changelog/${{ github.event.pull_request.number }}.<type>"
52+
echo "where <type> is one of: added, changed, deprecated, removed, fixed"
53+
echo "See CONTRIBUTING.md for details."
5854
echo ""
5955
echo "Or add the \"Skip Changelog\" label if this job should be skipped."
6056
false
6157
fi
58+
59+
- name: Preview changelog
60+
run: towncrier build --draft --version Unreleased

0 commit comments

Comments
 (0)