Added a changelog #85
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hrm, sorry about the lint failing - I thought I installed the pre-commit check, but it didn't seem to work. |
|
I'm going to close this, I didn't love the results, we can revisit later. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From suggestion in #77 (comment) I made an attempt at just copying and pasting a changelog.
It seems like it might be useful. Making this PR to discuss, to see if it's something we want - no problem if we decide not to, just wanted to see how it would actually work.
I was thinking we could just use GitHub's release note autogenerator to create it, but it looks like you need to add the tag first. So if we wanted the changelog to appear on a release I think we'd need to partially cut a release by making the tag, then make a PR with the changes to the changelog generated from that tag, and then I guess update the tag to include the changelog PR. Then fully cut the release.
So definitely more annoyance on release time, but probably better than making people add each change by hand when they make a PR. Or we could do that and adopt the keep a changelog form and get the added / changed / etc sections right - this doesn't do that since it's fully autogenerated.