-
Notifications
You must be signed in to change notification settings - Fork 107
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
Add CHANGELOG.md and use towncrier for automatic assembly #2496
Conversation
b13a83a
to
2d4f421
Compare
Codecov Report
@@ Coverage Diff @@
## master #2496 +/- ##
==========================================
+ Coverage 67.06% 67.21% +0.15%
==========================================
Files 324 324
Lines 29880 29880
==========================================
+ Hits 20038 20085 +47
+ Misses 7360 7322 -38
+ Partials 2482 2473 -9
Continue to review full report at Codecov.
|
5b120c7
to
0acb530
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.
Cool!
The lint on GitHub Actions seems to be failing though, seems like some issue with the remote branch not being fully fetched? Probably an explicit git fetch origin <BASE-BRANCH>
is needed because the linter tries to inspect what changed from the base branch.
And then run: | ||
|
||
```bash | ||
towncrier build --version <NEXT-VERSION> --draft |
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.
What about when you want to do an actual release?
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.
You would leave out the --draft
argument and towncrier would stage the changes, i.e. remove the Change Log fragments and add a new section to the CHANGELOG.md
.
After verifying that everything looks ok, you would just commit the changes.
I plan to create changelog
Make target that would call towncrier underneath to make things even simpler.
CHANGELOG.md
Outdated
|
||
## 19.0 (2019-12-18) | ||
|
||
- Initial release. |
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.
can we have this not say 19.0 (2019-12-18) is the initial release? it's not the initial release. if we don't want to go back and retroactively describe what changed between a9a532e and 19.0, it's less confusing not to have this section at all
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.
Agreed, this is not ideal. I would still like to have this section so that readers will know what the Change Log section for the next release, i.e. 19.1, refers to.
I've changed the contents to actually describe a process change, i.e. that the project started using a new versioning and release process and adopted a CalVer (calendar versioning) scheme. The latter also explains why this release has version 19.0 as opposed to 1.0 or similar.
Please, take another look.
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.
thx for the changes
f1da340
to
c8b606a
Compare
Yes, indeed the GitHub Checkout action only fetches the pull request branch by default. Added a command that manually fetches the |
It includes a lint job that checks for the presence of a Change Log fragment in a pull request.
c8b606a
to
8fd3c0c
Compare
Closes #759.