-
Notifications
You must be signed in to change notification settings - Fork 31
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
use towncrier
to handle changelog entries
#284
Merged
zacharyburnett
merged 5 commits into
spacetelescope:main
from
zacharyburnett:changelog/towncrier
Aug 30, 2024
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
dd124b1
use `towncrier` to handle changelog entries
zacharyburnett 2e6eabf
add change log entry
zacharyburnett 4955714
add changelog to docs
zacharyburnett b548703
looser grep
zacharyburnett f637123
make example more explicit
zacharyburnett File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,30 @@ | ||
name: Ensure changelog | ||
name: changelog | ||
|
||
on: | ||
pull_request: | ||
types: [labeled, unlabeled, opened, synchronize, reopened] | ||
types: | ||
- labeled | ||
- unlabeled | ||
- opened | ||
- synchronize | ||
- reopened | ||
|
||
# Only cancel in-progress jobs or runs for the current workflow | ||
# This cancels the already triggered workflows for a specific PR without canceling | ||
# other instances of this workflow (other PRs, scheduled triggers, etc) when something | ||
# within that PR re-triggers this CI | ||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
ensure_changelog: | ||
name: Verify that a changelog entry exists for this pull request | ||
check: | ||
if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }} | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: scientific-python/action-check-changelogfile@0.2 | ||
env: | ||
CHANGELOG_FILENAME: CHANGES.rst | ||
CHECK_MILESTONE: false | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
- uses: actions/setup-python@v5 | ||
with: | ||
python-version: 3 | ||
- uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- run: pip install . | ||
- run: pip install towncrier | ||
- run: towncrier check | ||
- run: towncrier build --draft | grep -P '#${{ github.event.number }}' |
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Fixed memory leak in C-extension. |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
use ``towncrier`` to handle changelog entries |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -29,3 +29,4 @@ Package Documentation | |
:maxdepth: 1 | ||
|
||
stcal/package_index.rst | ||
stcal/changes.rst |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,3 +7,4 @@ dependencies: | |
- pip | ||
- graphviz | ||
- sphinx_rtd_theme>1.2.0 | ||
- towncrier |
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
.. currentmodule:: stcal | ||
|
||
*********** | ||
Change Log | ||
*********** | ||
|
||
.. include:: ../../CHANGES.rst |
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Checklist
for a public change, added a towncrier news fragment in
changes/
:echo "changed something" > changes/<PR#>.<changetype>.rst
changes/<PR#>.apichange.rst
: change to public APIchanges/<PR#>.bugfix.rst
: fixes an issuechanges/<PR#>.general.rst
: infrastructure or miscellaneous changeupdated relevant tests
updated relevant documentation
updated relevant milestone(s)