Skip to content

Conversation

@odow
Copy link
Collaborator

@odow odow commented Feb 7, 2023

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.

mortenpi and others added 2 commits February 8, 2023 09:45
Co-authored-by: Oscar Dowson <odow@users.noreply.github.com>
Co-authored-by: Oscar Dowson <odow@users.noreply.github.com>
@odow
Copy link
Collaborator Author

odow commented Feb 7, 2023

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?

@mortenpi
Copy link
Member

mortenpi commented Feb 7, 2023

Is it possible to change the edit link for a particular page?

We should generate an at-meta block with an EditURL in release_notes.md.

@odow
Copy link
Collaborator Author

odow commented Feb 8, 2023

Added the dates with

$ git log --tags --simplify-by-decoration --pretty="format:%(describe:tags=yes) - %cs
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);

Copy link
Member

@mortenpi mortenpi left a 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...
This reverts commit cae55dd.

Okay, it's just easier to put a full URL in there. Replacing it with the
`[#1234](@ref)` links has the issue of clashing with the username
replacement below.
@mortenpi
Copy link
Member

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!

@mortenpi mortenpi merged commit a6c97e9 into master Feb 12, 2023
@mortenpi mortenpi deleted the od/changelog branch February 12, 2023 03:31
@odow
Copy link
Collaborator Author

odow commented Feb 12, 2023

This looks good: https://documenter.juliadocs.org/dev/release-notes/. We should definitely encourage packages to adopt the style.

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

Successfully merging this pull request may close these issues.

3 participants