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

Question: Where do find a changelog? #761

Closed
reitzig opened this issue May 18, 2020 · 3 comments
Closed

Question: Where do find a changelog? #761

reitzig opened this issue May 18, 2020 · 3 comments

Comments

@reitzig
Copy link
Contributor

reitzig commented May 18, 2020

As a maintainer of depending software, it's highly relevant to me to know what changed in SDKMAN!.

Can you please publish a changelog in an easily accessible way?

Places I looked:

@marc0der
Copy link
Member

marc0der commented May 18, 2020

Hi @reitzig, as you can see we don't currently have an explicit changelog. The closest thing is to look at the git commit history for now. That said, it should be possible to automate this and I'm happy to accept pull requests for enabling this. The current release script is very primitive (release.sh) and can be found in the bin folder of this project.

@reitzig
Copy link
Contributor Author

reitzig commented May 18, 2020

I don't think this can be automated in a reasonable way, at least not without very different input from the contributers.

  • There are dozens of commits in the 5.8 release. Not many of them have expressive, high level comments as would be needed for a meaningful changelog.
  • The same is true for the PR titles.

Without going through every PR in detail and cross-comparing the changes, I don't see a way to come up with a meaningful changelog.

There are many ways to curate one (e.g. CHANGELOG file that each PR needs to make a meaningful addition to), and prepared ways to have notes end up in GitHub Releases (IIRC, annotated tags work wonderfully). If something like a CHANGELOG file existed, creating the tag annotation would be simple and I'd happy to help. But I'm not in the position to summarize the work being done.

(FWIW, I think if you use GitHub Projects with Milestones or somesuch, and have appropriately cut stories in them, you could automatically generate a changelog from that as well. Just as an option, doesn't apply here.)

@reitzig
Copy link
Contributor Author

reitzig commented Jan 29, 2021

There are changelogs now -- thank you! 🎉

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