Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the ability to additionally add the changelog to a separate file like CHANGELOG.md #412

Open
ryan-blakley opened this issue Oct 6, 2021 · 1 comment
Labels
effort/medium Can be done in 1-2 days gain/medium Affects multiple users RFE This issue is a Request For Enhancement (Feature)

Comments

@ryan-blakley
Copy link

It would be nice to have the ability to append the changelog to an external file like a CHANGELOG.md file. Also possibly add the ability to add a jinja template for the external file, since most external changelog files are md or rst files.

@FrostyX
Copy link
Member

FrostyX commented Oct 10, 2021

Hello @ryan-blakley,
that is indeed a good idea.

Tito can already generate files from templates when tagging a new version. There is not much documentation for it but it is mentioned for example here
https://docs.fedoraproject.org/en-US/quick-docs/publish-rpm-on-copr/#_step_4_let_tito_manage_the_program_version
and in this repository, we use it to generate src/tito/__init__.py. At this moment, only $version and $release variables can be substituted in the template but we could support $changelog as well. Would this work for you?

Also possibly add the ability to add a jinja template

Jinja2 would be my preferred templating engine but since we already support templates, migrating to Jinja2 is a lower priority for me (unless there is some use case that requires it)

since most external changelog files are md or rst files.

The main problem I see is what should be the format of the changelog? There isn't going to be anything compatible across all the markup languages, so I suppose we would have to somehow let users define their custom format. What are your thoughts on this?

@FrostyX FrostyX added RFE This issue is a Request For Enhancement (Feature) effort/medium Can be done in 1-2 days gain/medium Affects multiple users labels Jan 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/medium Can be done in 1-2 days gain/medium Affects multiple users RFE This issue is a Request For Enhancement (Feature)
Projects
None yet
Development

No branches or pull requests

2 participants