Merge branch 'main' into list-dependencies

Author: lagru

.github/workflows/label-check.yaml

@@ -4,8 +4,10 @@ on:
   pull_request:
     types:
       - opened
+      - reopened
       - labeled
       - unlabeled
+      - synchronize
 
 env:
   LABELS: ${{ join( github.event.pull_request.labels.*.name, ' ' ) }}

.github/workflows/lint.yml

@@ -11,7 +11,7 @@ jobs:
         python-version: ["3.11"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:

.github/workflows/milestone-merged-prs.yaml

@@ -12,7 +12,7 @@ jobs:
     name: attach to PR
     runs-on: ubuntu-latest
     steps:
-      - uses: scientific-python/attach-next-milestone-action@f94a5235518d4d34911c41e19d780b8e79d42238
+      - uses: scientific-python/attach-next-milestone-action@bc07be829f693829263e57d5e8489f4e57d3d420
         with:
           token: ${{ secrets.MILESTONE_LABELER_TOKEN }}
           force: true

CHANGELOG.md

@@ -1,3 +1,81 @@
+# changelist 0.3
+
+We're happy to announce the release of changelist 0.3!
+
+## Enhancements
+
+- Add newline before lists in contributor section ([#40](https://github.com/scientific-python/changelist/pull/40)).
+
+## Bug Fixes
+
+- Add newline after PR sections ([#35](https://github.com/scientific-python/changelist/pull/35)).
+
+## Maintenance
+
+- Update setuptools requirement ([#37](https://github.com/scientific-python/changelist/pull/37)).
+
+## Documentation
+
+- Link to example in README ([#36](https://github.com/scientific-python/changelist/pull/36)).
+- Fix CHANGELOG format ([#38](https://github.com/scientific-python/changelist/pull/38)).
+
+## Contributors
+
+1 authors added to this release (alphabetically):
+
+- Jarrod Millman ([@jarrodmillman](https://github.com/jarrodmillman))
+
+1 reviewers added to this release (alphabetically):
+
+- Jarrod Millman ([@jarrodmillman](https://github.com/jarrodmillman))
+
+_These lists are automatically generated, and may not be complete or may contain duplicates._
+
+# changelist 0.2
+
+We're happy to announce the release of changelist 0.2!
+
+## Enhancements
+
+- Ensure label check runs on all PR push events / commits ([#22](https://github.com/scientific-python/changelist/pull/22)).
+- Remove newlines between pull request summaries and their links ([#27](https://github.com/scientific-python/changelist/pull/27)).
+
+## Bug Fixes
+
+- Format contributor section as lists ([#28](https://github.com/scientific-python/changelist/pull/28)).
+
+## Maintenance
+
+- Refactor into submodules ([#20](https://github.com/scientific-python/changelist/pull/20)).
+- Bump scientific-python/attach-next-milestone-action from f94a5235518d4d34911c41e19d780b8e79d42238 to bc07be829f693829263e57d5e8489f4e57d3d420 ([#21](https://github.com/scientific-python/changelist/pull/21)).
+- Bump actions/checkout from 3 to 4 ([#31](https://github.com/scientific-python/changelist/pull/31)).
+- Bump pre-commit from 3.3.3 to 3.4.0 ([#32](https://github.com/scientific-python/changelist/pull/32)).
+- Update README ([#33](https://github.com/scientific-python/changelist/pull/33)).
+
+## Documentation
+
+- Improve release process ([#14](https://github.com/scientific-python/changelist/pull/14)).
+- Ensure label check runs on all PR push events / commits ([#22](https://github.com/scientific-python/changelist/pull/22)).
+
+## Contributors
+
+5 authors added to this release (alphabetically):
+
+- [@dependabot[bot]](https://github.com/apps/dependabot)
+- Brigitta Sipőcz ([@bsipocz](https://github.com/bsipocz))
+- Jarrod Millman ([@jarrodmillman](https://github.com/jarrodmillman))
+- Lars Grüter ([@lagru](https://github.com/lagru))
+- Stefan van der Walt ([@stefanv](https://github.com/stefanv))
+
+4 reviewers added to this release (alphabetically):
+
+- Eric Larson ([@larsoner](https://github.com/larsoner))
+- Jarrod Millman ([@jarrodmillman](https://github.com/jarrodmillman))
+- Lars Grüter ([@lagru](https://github.com/lagru))
+- Stefan van der Walt ([@stefanv](https://github.com/stefanv))
+
+_These lists are automatically generated, and may not be complete or may contain duplicates._
+
 # changelist 0.1
 
 We're happy to announce the release of changelist 0.1!

MANIFEST.in

@@ -0,0 +1 @@
+include src/changelist/*.toml

README.md

@@ -1,6 +1,19 @@
 # changelist
 
-Prepare an automatic changelog from GitHub pull requests.
+Changelist helps you write better release notes by automating as much of the
+process as possible. For example, see
+https://github.com/scientific-python/changelist/blob/main/CHANGELOG.md.
+
+**Features**
+
+- Compile a list of pull requests, code authors and reviewers between any two
+  valid Git objects (refs).
+- Categorize pull requests into sections based on GitHub labels.
+- Point it at any repository on GitHub. No need to clone or checkout a
+  repository locally, a Python package is all that's needed.
+
+We recommend to treat the generated document as a first draft to build
+on and not as an already perfect documentation of the release.
 
 _This project is currently in its alpha stage and might be incomplete or change a lot!_
 
@@ -10,26 +23,101 @@ _This project is currently in its alpha stage and might be incomplete or change
 pip install changelist
 ```
 
-## Set up your repository
+## Usage
+
+The script requires a [GitHub personal access
+token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
+The token does not need any permissions, since it is used only to
+increase query limits.
+
+```sh
+export GH_TOKEN='...'
+changelist scientific-python/changelist v0.2.0 main
+```
 
-To categorize merged PRs in the changelist, each PR
-must have have one of the following labels:
+This will list all pull requests, authors and reviewers that touched commits
+between `v0.2.0` and `main` (excluding `v0.2.0`).
+Pull requests are sorted into section according to the configuration in
+`tool.changelist.label_section_map`.
+
+## Configuration
+
+changelist can be configured from two sources, in order of precedence:
+
+- A local TOML file specified with the `--config` option
+- A remote `pyproject.toml` at `stop_rev`
+
+If a configuration option is not specified in either file above, changelist
+falls back to the following configuration:
+
+````toml
+# Default changelist configuration as supported in pyproject.toml
+[tool.changelist]
+
+# A template string that is included as the title of the generated notes.
+# "{repo_name}" and "{version}", if given, are replaced by the respective
+# values given in the command line.
+title_template = "{repo_name} {version}"
+
+# A template string that is included as introductory text after the title.
+# "{repo_name}" and "{version}", if given, are replaced by the respective
+# values given in the command line.
+intro_template = """
+We're happy to announce the release of {repo_name} {version}!
+"""
+
+# A template string that is included at the end of the generated notes.
+# "{repo_name}" and "{version}", if given, are replaced by the respective
+# values given in the command line.
+outro_template = """
+_These lists are automatically generated, and may not be complete or may contain
+duplicates._
+"""
+
+# Profiles that are excluded from the contributor list.
+ignored_user_logins = [
+    "web-flow",
+]
+
+# If this regex matches a pull requests description, the captured content
+# is included instead of the pull request title.
+# E.g. the default regex below is matched by
+#
+# ```release-note
+# An ideally expressive description of the change that is included as a single
+# bullet point. Newlines are removed.
+# ```
+#
+# If you modify this regex, make sure to match the content with a capture
+# group named "summary".
+pr_summary_regex = "^```release-note\\s*(?P<summary>[\\s\\S]*?\\w[\\s\\S]*?)\\s*^```"
+
+# If any of a pull request's labels matches one of the regexes on the left side
+# its summary will appear in the appropriate section with the title given on
+# the right side. If a pull request doesn't match one of these categories it is
+# sorted into a section titled "Other". Pull request can appear in multiple
+# sections as long as their labels match.
+[tool.changelist.label_section_map]
+".*Highlight.*" = "Highlights"
+".*New feature.*" = "New Features"
+".*API.*" = "API Changes"
+".*Enhancement.*" = "Enhancements"
+".*Performance.*" = "Performance"
+".*Bug fix.*" = "Bug Fixes"
+".*Documentation.*" = "Documentation"
+".*Infrastructure.*" = "Infrastructure"
+".*Maintenance.*" = "Maintenance"
+````
 
-- `type: Highlights`
-- `type: New features`
-- `type: Enhancements`
-- `type: Performance`
-- `type: Bug fix`
-- `type: API`
-- `type: Maintenance`
-- `type: Documentation`
-- `type: Infrastructure`
+## Set up your repository
 
-This list will soon be configurable.
+To categorize merged PRs in the changelist with the default configuration, each
+PR must have a label that matches one of the regexes on the left side of the
+`label_section_map` table, e.g. `type: Highlights`.
 
 ### Label checking
 
-To ensure that each PR has an associated `type: ` label,
+You may want to ensure that each PR has an associated `type: ` label,
 we recommend adding an action that fails CI if the label is missing.
 
 To do so, place the following in `.github/workflows/label-check.yaml`:
@@ -41,8 +129,10 @@ on:
   pull_request:
     types:
       - opened
+      - repoened
       - labeled
       - unlabeled
+      - synchronize
 
 env:
   LABELS: ${{ join( github.event.pull_request.labels.*.name, ' ' ) }}
@@ -79,22 +169,10 @@ jobs:
     name: attach to PR
     runs-on: ubuntu-latest
     steps:
-      - uses: scientific-python/attach-next-milestone-action@f94a5235518d4d34911c41e19d780b8e79d42238
+      - uses: scientific-python/attach-next-milestone-action@bc07be829f693829263e57d5e8489f4e57d3d420
         with:
           token: ${{ secrets.MILESTONE_LABELER_TOKEN }}
           force: true
 ```
 
 See https://github.com/scientific-python/attach-next-milestone-action for more information.
-
-## Usage
-
-```sh
-export GH_TOKEN='...'
-changelist scikit-image/scikit-image v0.21.0 main
-```
-
-The script requires a [GitHub personal access
-token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
-The token does not need any permissions, since it is used only to
-increase query limits.

pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=43.0.0", "wheel"]
+requires = ["setuptools>=68.0.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "changelist"
-version = "0.1"
+version = "0.4rc0.dev0"
 requires-python = ">=3.9"
 readme = "README.md"
 license = {file = "LICENSE.txt"}
@@ -33,7 +33,7 @@ dependencies = [
 changelist = "changelist.__main__:main"
 
 [project.optional-dependencies]
-lint = ["pre-commit == 3.3.3"]
+lint = ["pre-commit == 3.4.0"]
 
 [tool.ruff]
 line-length = 88