Display relevant release notes after update #2308
bradbeattie
started this conversation in
Ideas
Replies: 1 comment 1 reply
|
I see some benefit in printing the changelog after an update, but I also see some edge cases that may make this difficult to automate properly:
Also, there are a few different changelog formats, and template maintainers may even invent their own. If we supported this in Copier, we'd at least need to support a range of common changelog formats, perhaps offer a way to configure custom ones. How about this: Migration tasks have access to a few additional variables like _message_after_update: |
{%- if _version_pep440_from and _version_pep440_to and _version_pep440_to > _version_pep440_from %}
{%- filter regex_search('(?ms)^## \[' ~ _version_to ~ '\].*?(?=^## |\Z)') %}
{%- include 'CHANGELOG.md' -%}
{%- endfilter %}
{%- endif %} |
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
When a developer uses my template and runs
copier update, I'd like to be able to give them a summary of what they see when theygit status. I can display a static message with message_after_update that links to my template's release notes, but there's a level of indirection there that's unsatisfying.Some ideas, but I'm unclear on how acceptable each would be:
I haven't written a PR yet, but I'm happy to take on the effort of developing this. I just wanted to avoid writing it up if this idea doesn't fit within the goals of the project.
All reactions