Use changelist #86
Use changelist #86
Conversation
jarrodmillman
added
the
type: Maintenance
| @@ -14,8 +14,9 @@ Example `version` | |||
|
|
|||
| - Update and review `CHANGELOG.md`: | |||
|
|
|||
| gem install github_changelog_generator | |||
| github_changelog_generator -u scientific-python -p spin --since-tag=<last tag> | |||
| changelist scientific-python/spin <v0.0> main --version <0.1> >> CHANGELOG.md | |||
There was a problem hiding this comment.
| changelist scientific-python/spin <v0.0> main --version <0.1> >> CHANGELOG.md | |
| changelist scientific-python/spin v0.0 main --version v0.1 > CHANGELOG.md |
Not sure if that should be v0.1 or 0.1
There was a problem hiding this comment.
We can take out the angle brackets indicating what needs to be changed. But we need to leave in the >>.
There was a problem hiding this comment.
If you take out the angle brackets, we should make it clear that that text needs to be changed in another way. Maybe just explain it in the text below.
There was a problem hiding this comment.
An argument for keeping the angle brackets is that is the standard notation for indicating a manadatory argument that needs to be replaced when used.
There was a problem hiding this comment.
Maybe you would prefer
changelist scientific-python/spin <last tag> main --version <next version> >> CHANGELOG.md
It is a little long though, but we could remove the explanatory text.
There was a problem hiding this comment.
It'd be nice to be able to copy, paste, and modify. The brackets are a bit noisy and hard to read.
| github_changelog_generator -u scientific-python -p spin --since-tag=<last tag> | ||
| changelist scientific-python/spin <v0.0> main --version <0.1> >> CHANGELOG.md | ||
|
|
||
| where <v0.0> is the last release and <0.1> is the new one. |
There was a problem hiding this comment.
| where <v0.0> is the last release and <0.1> is the new one. | |
| replacing v0.0 with the previous release and v0.1 is the new one. |
Not sure if that should be v0.1 or 0.1?
There was a problem hiding this comment.
The 0.1 is used in the CHANGELOG and the v0.0 is a tag. We've been prepending v to the release tags, which is pretty common and we should stick with it. I think the release number shouldn't have the v prepended. If it does, then the CHANGELOG will say things like:
We're happy to announce the release of spin v0.1!
I think it looks better the way I had it
We're happy to announce the release of spin 0.1!
Feel free to make a PR to make whatever changes you want. I don't have a strong opinion on this. I will copy your changes to the other sites to keep things consistent.
No description provided.