Skip to content
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

Include code changes in release notes #27

Closed
dideler opened this issue Jan 21, 2018 · 3 comments
Closed

Include code changes in release notes #27

dideler opened this issue Jan 21, 2018 · 3 comments

Comments

@dideler
Copy link
Owner

dideler commented Jan 21, 2018

We currently have release notes under our releases page, which is great for the average user. But technical users are also interested in the source changes, which we don't cover well at the moment. We should start including a commit range in every release. We can backfill existing releases.

Normally such stuff would live in a CHANGELOG. But I'm hesitant to add a CHANGELOG in addition to the Releases because it creates more process by having to put release notes in two places. If we do decide to have a CHANGELOG, one option is to keep it empty and have it link to the Releases.

@dideler
Copy link
Owner Author

dideler commented Jan 27, 2018

Started updating Releases using a comparison between tags such as https://github.com/dideler/toggle-youtube-comments/compare/<old-tag>...<new-tag>

Have to head out for a bit, still have a few more to go before we can close this ticket.

@dideler
Copy link
Owner Author

dideler commented Jan 27, 2018

Backfilled the change comparison on all Releases.

Note the comparisons for the first two releases did not play well with tags, so had to use commit SHAs instead.

@dideler dideler closed this as completed Jan 27, 2018
@1natsu172
Copy link
Collaborator

Great work! And thanks!
Although I couldn't think of it, tag comparison is a very good solution! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants