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

New properties for closest tag message #109

Open
nxn-4-wdf opened this issue Mar 6, 2024 · 0 comments
Open

New properties for closest tag message #109

nxn-4-wdf opened this issue Mar 6, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@nxn-4-wdf
Copy link

nxn-4-wdf commented Mar 6, 2024

Describe the idea (required)

Properties commit.message.full and commit.message.short are useful to get information about the last commit.
But it is often quite technical.

If you want a more general, semantic description, it is in the messages from annotated tags, for example, created with git tag -a <tagname> -m "Message for tag <tagname>..." .

I would suggest to get the closest tag annotation and put it into new properties, for example, with names closest.tag.message.full and closest.tag.message.short.

Tell us about the expected behaviour (required)

You can get these messages with command git tag and option -n.

More specifically, when the user requests:

  • closest.tag.message.full: get the output of git tag -n99 <tagname> (full message, maximum 99 lines)
  • closest.tag.message.short: get the output of git tag -n1 <tagname> (only 1 line)

If the closest tag is not annotated, the git commands automatically get the message from the last git commit instead, therefore, this would be equivalent to git.commit.message.*.

Context (optional)

A tag usually represents a new release or a new version of the code.

Well used, an annotated tag message provides a practical way to convey a high-level summary over the content of this release.

@nxn-4-wdf nxn-4-wdf added enhancement New feature or request to-triage labels Mar 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants