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.

Sign up for GitHub

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

Jump to bottom

Update the Github Releases FAQ Item #351

Open
Blacksmoke16 opened this issue Jun 4, 2020 · 3 comments · May be fixed by #427
Open

Update the Github Releases FAQ Item #351

Blacksmoke16 opened this issue Jun 4, 2020 · 3 comments · May be fixed by #427
Labels
enhancement

Comments

@Blacksmoke16
Copy link

Currently this section mentions:

Another minor issue is that the interface doesn't currently offer links to commit logs between each release.

However this is no longer the case. Projects that are making use of Github Releases as their changelog now have a feature for this. Each release includes a Compare dropdown that allows viewing the commits in between tags, the files that changed, and any comments left on the commits.

For example: https://github.com/crystal-lang/crystal/releases/tag/0.34.0 and the related diff crystal-lang/crystal@0.33.0...0.34.0.
@reitzig
Copy link

reitzig commented Jun 22, 2020 •
edited
Loading

It may also be useful to point to relevant GitHub Actions. For instance, anton-yurchenko/git-release includes support for populating the release notes from keep-a-changelog changelogs!

@PaulRBerg PaulRBerg linked a pull request Mar 12, 2022 that will close this issue
Open
@PaulRBerg
Copy link

Just created a PR for this.

#427

@SlowMo24
Copy link

SlowMo24 commented Sep 5, 2024

I would suggest adding a recommendation to copy the latest CHANGELOG items to the GitHub/GitLab release notes (at least thats what I do and what is the major benefit of the Changelog -> quick release notes)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
Keep a Changelog 2.0
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update GitHub Release faq item PaulRBerg/keep-a-changelog
5 participants
@olivierlacan @reitzig @PaulRBerg @Blacksmoke16 @SlowMo24