search

abelsiqueira / BestieTemplate.jl

Template for Julia Programming Language packages using the copier engine.
http://abelsiqueira.com/BestieTemplate.jl/
Mozilla Public License 2.0
14 stars 6 forks source link

Evaluate Changelog.jl #55

Open abelsiqueira opened 2 months ago

abelsiqueira commented 2 months ago

Announcement: https://discourse.julialang.org/t/changelog-jl-release-announcement/112996

abelsiqueira commented 1 month ago

Check if it works with https://www.conventionalcommits.org/en/v1.0.0/

abelsiqueira commented 1 month ago

As it is right now, the tool provides two things:

  1. Create links at the bottom of a CHANGELOG.md file when scanning links like ([#XXX]) and others. In other words, it helps identify missing "reference style links" and fix them when possible. It might be useful as a fix action, but it would be more interesting if the changelog file was fully managed by the package.

  2. Convert CHANGELOG.md into a Documenter compatible md. Essentially, Documenter is not a complete Markdown parser, to the reference style links are not translated into explicit links. Changelog converts one into the other.

The main usage for us would be as a pre-commit hook to fix these links, although using Julia for that might be overkill. I haven't looked into alternatives.

abelsiqueira commented 1 month ago

After https://github.com/JuliaDocs/Changelog.jl/issues/6 we should reevaluate and decide how to proceed.