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

Allow including tag-message in changelog #623

Open
1 task done
chrichrichri opened this issue Apr 23, 2024 · 4 comments
Open
1 task done

Allow including tag-message in changelog #623

chrichrichri opened this issue Apr 23, 2024 · 4 comments
Assignees
Labels
feature/request New feature or request good first issue Good for newcomers

Comments

@chrichrichri
Copy link

chrichrichri commented Apr 23, 2024

Is there an existing issue or pull request for this?

  • I have searched the existing issues and pull requests

Feature description

To have a "headline" for a release, it would be great allow including tag-messages (of release tags) into the changelog. For example, a changelog including this headline could look like this:

# Changelog

All notable changes to this project will be documented in this file.

## [1.0.1] - 2021-07-18

This is the release-tag message

### Miscellaneous Tasks
- Add release script

### Refactor

- Expose string functions

Desired solution

Provide variable (such as tag_message) to the context, so it can be used as a variable within the changelog template.

Alternatives considered

N/A

Additional context

No response

@chrichrichri chrichrichri added the feature/request New feature or request label Apr 23, 2024
Copy link

welcome bot commented Apr 23, 2024

Thanks for opening your first issue at git-cliff! Be sure to follow the issue template! ⛰️

@orhun orhun added the good first issue Good for newcomers label Apr 26, 2024
@orhun
Copy link
Owner

orhun commented Apr 26, 2024

Pretty good idea! The implementation should be pretty straightforward thanks to Tag::message method. Marked as good first issue.

@alerque
Copy link
Contributor

alerque commented Apr 26, 2024

This will get into cart vs. horse territory for many projects as the finished changelog is expected inside the tagged commit not later. Perhaps an env var could be used to hold the tag message and then used both for the changelog and subsequent actual tag message.

@orhun
Copy link
Owner

orhun commented Apr 26, 2024

Or maybe we can add a new argument similar to --with-commit such as --tag-message?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature/request New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants