-
Notifications
You must be signed in to change notification settings - Fork 78
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
New changelog conventions #505
base: main
Are you sure you want to change the base?
Conversation
Codecov Report
@@ Coverage Diff @@
## master #505 +/- ##
========================================
- Coverage 78.8% 78.7% -0.1%
========================================
Files 122 122
Lines 13100 13185 +85
========================================
+ Hits 10320 10374 +54
- Misses 2780 2811 +31
|
To avoid conflicts in the changelog, we might add a
We add tooling that globs the digest directory for all entries that have empty
After the changelog is updated, the digest entry gets updated:
ReleaseWhen it comes time to do the release, the changelog.md file goes from:
to
And we continue on post-release with the This is a blend of curation (digests) and automation. |
At the Jan-23 dev meeting, we decided to drop the digest idea and instead keep the The PR template likely needs adjusting to reflect this. |
It would be great to standardize the changelogs across all pysal packages. Building on the work @jGaboardi has done with ghactions, I think we can come up with a mapping of labels -> categories to get automated changelogs and release notes that are the same structure across the packages. I re-added the WIP label so we can have a discussion of this to flesh the design out here. |
We can add labels to already merged PRs, so this could be done now with an eye towards the meta release and aggregating across the packages. |
Always willing to try something new for a better user experience. |
Perhaps the new effort out of the scientific-python changelist is what we should use instead of rolling our own? |
This is modeled after how to keep a changelog .
Opening up for discussion of conventions for how to keep our changelogs across the federation, using libpysal as a test case.