Skip to content

Commit

Permalink
update documentation to reference towncrier news fragments
Browse files Browse the repository at this point in the history
  • Loading branch information
zacharyburnett committed Aug 19, 2024
1 parent 2cb9abd commit 6408eea
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 15 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,6 @@ If this PR fixes an issue, please add closing keywords (eg 'fixes #XXX')

- [ ] pre-commit checks ran successfully
- [ ] tests ran successfully
- [ ] for a public change, a changelog entry was added
- [ ] for a public change, documentation was updated
- [ ] for a public change, added news fragment (`changes/<PR#>.<changetype>.rst`)
- [ ] for a public change, updated documentation
- [ ] for any new features, unit tests were added
27 changes: 14 additions & 13 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
name: 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:
changelog:
name: Confirm changelog entry
check:
if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- uses: actions/setup-python@v5
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Grep for PR number in CHANGES.rst
run: grep -P '\[[^\]]*#${{github.event.number}}[,\]]' CHANGES.rst
if: ${{ !contains(github.event.pull_request.labels.*.name, 'no-changelog-entry-needed') }}
- run: pip install towncrier
- run: towncrier build
- run: grep -P '\[[^\]]*#${{github.event.number}}[,\]]' CHANGES.rst
10 changes: 10 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,13 @@ to the maintainers, who are glad to assist you.
a maintainer, you can comment ``@meeseeksdev backport to <branch>`` on a pull
request to manually trigger a backport. Moreover, when merging a "backport"
pull request, please use the "Rebase and merge" option.

.. note::
When making a public change, add a news fragment to ``changes/`` with the
filename ``<PR#>.<changetype>.rst``. The change types are as follows:

- ``feature``: new feature
- ``bugfix``: bug fix
- ``doc``: documentation change
- ``removal``: deprecation or removal of public API
- ``misc``: not of interest to users

0 comments on commit 6408eea

Please sign in to comment.