# Changelog.jl release announcement

**URL:** <https://discourse.julialang.org/t/changelog-jl-release-announcement/112996>\
**Category:** Package Announcements\
**Created:** [April 16, 2024, 8:04am UTC](https://discourse.julialang.org/t/changelog-jl-release-announcement/112996 "2024-04-16T08:04:55Z")\
**Posts on this page:** 1\
**Page:** 1

<div class="post-metadata">

**Author:** ![fredrikekre](https://sea2.discourse-cdn.com/julialang/user_avatar/discourse.julialang.org/fredrikekre/32/1688_2.png) [@fredrikekre](https://discourse.julialang.org/u/fredrikekre)\
**Post date:** [April 16, 2024, 8:04am UTC](https://discourse.julialang.org/t/changelog-jl-release-announcement/112996/1 "2024-04-16T08:04:55Z")

</div>

I want to announce [Changelog.jl](https://github.com/JuliaDocs/Changelog.jl) – a small utility package that helps with changelog maintenance. It was released in the registry back in November last year but was never announced here.

* * *

The two main functionalities are:

1. Link generation from link stubs, for example:

2. Output generation. [Changelog.jl](https://github.com/JuliaDocs/Changelog.jl) process the source-changelog and can output:

- Regular markdown where all the links are included in the footer. Typically this output is the repository CHANGELOG.md and is the same file as the source – [Changelog.jl](https://github.com/JuliaDocs/Changelog.jl) updates this file in-place.
- Documenter compatible markdown that can be used to render a HTML version of the changelog to be included in the package documentation.

[Changelog.jl](https://github.com/JuliaDocs/Changelog.jl) is already used by a number of packages. To give a concrete example you can have a look at [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl)’s [CHANGELOG.md](https://github.com/JuliaDocs/Documenter.jl/blob/master/CHANGELOG.md?plain=1):

- [Example of a release link](https://github.com/JuliaDocs/Documenter.jl/blob/65deb630d84b349a3a894a054ddb2607ebc65fbd/CHANGELOG.md?plain=1#L6)
- [Example of PR links](https://github.com/JuliaDocs/Documenter.jl/blob/65deb630d84b349a3a894a054ddb2607ebc65fbd/CHANGELOG.md?plain=1#L24-L28)
- [Generated links in the footer](https://github.com/JuliaDocs/Documenter.jl/blob/65deb630d84b349a3a894a054ddb2607ebc65fbd/CHANGELOG.md?plain=1#L1255-L1829)

The Documenter-rendered version of this changelog can be seen here: [Documenter release notes](https://documenter.juliadocs.org/stable/release-notes/).

* * *

[Changelog.jl](https://github.com/JuliaDocs/Changelog.jl) has been split out from some scripts that we had in [Documenter.jl](https://github.com/JuliaDocs/Documenter.jl) so that it could be used more widely. The code was originally authored by @odow for JuMP’s documentation and was included in Documenter in [Documenter.jl#2035](https://github.com/JuliaDocs/Documenter.jl/pull/2035) and later improved in e.g. [Documenter.jl#2184](https://github.com/JuliaDocs/Documenter.jl/pull/2184) before it was split out into a separate package.

* * *

I hope you find this useful. If you have any feedback please open an issue or post here. Thanks!\[1\]

* * *

1. Please write changelogs.