executablebooks / github-activity

Simple markdown changelogs for GitHub repositories
https://github-activity.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
47 stars 11 forks source link

ability to exclude backported PRs #84

Open minrk opened 1 year ago

minrk commented 1 year ago

Context

In several of our projects, we backport fixes to a previous release while working on a major release in main - it would be useful to be able to exclude the backported PR so the change doesn't appear twice or give the misleading indication that a feature or bugfix originally made on the development branch for 4.0 was not also released in e.g. 3.1.

For example, in making the changelog for JupyterHub 4.0, I get in the enhancements:

when none of these should be included as changes in 4.0.

so each backported change is present twice, when what I want is for none of these 4 entries. (-b main excludes the backports, but I currently like to include them because it helps with the manual deletions of the duplicates!)

Proposal

A simple version would be to allow excluding on a specific label (or label pattern). Doing this by default might present problems, because the exclusions might be the opposite of what you want for the backport release. If you use backport-pr tools like mrmeeseeks (or manual backporting with a separate PR), though, this shouldn't be an issue because the change already appears twice as two separate PRs, and only the 'mainline' PR should be excluded, which would be the one with the label.

Tasks and updates