Change the changelog infrastructure #2184
Conversation
|
I was getting annoyed by the missing links when viewing the changelog directly on github. After this patch, entries in the changelog should be of the form (Perhaps we should have a makefile with things like this). |
This patch changes how the changelog is written in order to support links in both the CHANGELOG.md as viewed on GitHub, and in the generated HTML. The changelog related code is moved into docs/changelog.jl which now has two purposes: i) generate the Documenter friendly markdown for the manual, and ii) generate links to add to the footer of the CHANGELOG.md file directly. The latter can be triggered by 'make changelog'.
fredrikekre
force-pushed
the
fe/readme-links
branch
from
7107a68 to
544b76b
Compare
| @@ -0,0 +1,138 @@ | |||
| # ================================================================================= | |||
| # Utilities for managing CHANGELOG.md and generating a Documenter-friendly version | |||
| # ================================================================================= | |||
There was a problem hiding this comment.
it seems like this file could even be in src so it can be re-used by any project using Documenter?
There was a problem hiding this comment.
I think this should be re-used, yes, but I lean towards this being in a separate package, so that it could be versioned independently and hopefully more rapidly than Documenter itself.
That said, we could still drop it into src/ if you want to re-use this for e.g. JuMP right away, and just not promise this as official API (but secretly promise to you that we won't drop it on the 1.0.x branch, for example)?
There was a problem hiding this comment.
Or, to be fair, if we generally agree that this should be a separate package, we could just copy-paste it into that new package now as is, and tag that as 0.1.0, and then iterate on that as needed.
|
I went ahead and merged this as is, so that we wouldn't have to deal with conflicts due to the formatting changes in the CHANGELOG. I don't think we have any disagreements about the new format. We can always shuffle the code around in a follow-up PR. |
|
Just used |
|
FYI, I started working on https://github.com/JuliaDocs/Changelog.jl so we can maybe move to that once that is finished. |
This patch changes how the changelog is written in order to support links in both the CHANGELOG.md as viewed on GitHub, and in the generated HTML. The changelog related code is moved into docs/changelog.jl which now has two purposes: i) generate the Documenter friendly markdown for the manual, and ii) generate links to add to the footer of the CHANGELOG.md file directly.