-
Notifications
You must be signed in to change notification settings - Fork 272
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 for change log #2144
Conversation
Codecov ReportBase: 92.75% // Head: 92.76% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #2144 +/- ##
=======================================
Coverage 92.75% 92.76%
=======================================
Files 216 216
Lines 18050 18045 -5
=======================================
- Hits 16742 16739 -3
+ Misses 1308 1306 -2
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
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.
I am not sure we really need the sub-directories for each submodule.
This is just the astropy way of having sections in the change log. I can remove them and write all news fragments in the |
2900b16
to
fe9162f
Compare
I hesitate to review this, because I have no experience with towncrier or any other automatic changelog generation. What would the "Changes: Using towncrier" entry from this PR look like? Can you already include it in this PR? I assume this PR can already include some developer documentation. Apropos documentation: The Docs CI is failing. |
|
Docs also fail on #2138 with the same error |
Astropy has a CI that checks for the changelog entry or the label "no-changelog-needed". Can you also add to the docs (or link to the astropy docs if identical) what the maintainers have to do for a new release? |
Yes I can add it to the readme in the changes folder. It's as simple as |
This is what we want https://github.com/pllim/actions-towncrier-changelog |
The check requires this app https://github.com/Cadair/giles |
a6bde48
to
007d54b
Compare
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.
I think now we just need to update the developer guide to explain how to use this. It can go in the making a pull request page (which in any case needs some updating).
2b95392
to
2267488
Compare
625a2e1
to
28e2e13
Compare
closes #1995