-
Notifications
You must be signed in to change notification settings - Fork 499
Refactor CHANGELOG.md to the Keep a Changelog style #2035
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
Conversation
Co-authored-by: Oscar Dowson <odow@users.noreply.github.com>
Co-authored-by: Oscar Dowson <odow@users.noreply.github.com>
|
The other issue is that if you click "Edit" in the documentation, it tries to redirect you to https://github.com/JuliaDocs/Documenter.jl/blob/master/docs/src/release_notes.md. Is it possible to change the edit link for a particular page? |
We should generate an at-meta block with an |
|
Added the dates with tags ="""
# Copy-pasted output from git script above
"""
file = read("CHANGELOG.md", String);
for line in split(tags, "\n")
tag, date = String.(split(line, " - "))
file = replace(file, "## Version $tag\n" => "## Version $tag - $date\n")
end
write("CHANGELOG.md", file); |
mortenpi
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Alright, I think this is basically good to go. I'll just make a couple of tiny modifications.
May need to revert this...
|
Alright, let's get this merged. We can do any code organizational changes for re-use in a separate PR. Thanks a lot @odow, especially for taking the time to convert the existing changelog! |
|
This looks good: https://documenter.juliadocs.org/dev/release-notes/. We should definitely encourage packages to adopt the style. |
I'll add the preview link once it runs: https://documenter.juliadocs.org/previews/PR2035/release_notes/
There has been some discussion on Slack about package changelogs.
The general consensus was that following https://keepachangelog.com/en/1.0.0/ is good practice.
Existing examples:
The JuMP release notes are slightly complicated because they are built on-demand from a simplified file:
I've followed the JuMP approach here. Open to suggestions/discussions for what we could do differently, and how this could be incorporated more directly into Documenter.
cc @giordano
I haven't gone through and looked up the date each release was tagged, but that would be good to have.
Ideally, we'll aim for something standard here so that other packages can copy.