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

support nameless/noteless releases #2

Open
3 of 4 tasks
JeanMertz opened this issue Aug 12, 2019 · 1 comment
Open
3 of 4 tasks

support nameless/noteless releases #2

JeanMertz opened this issue Aug 12, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@JeanMertz
Copy link
Member

JeanMertz commented Aug 12, 2019

The current template expects there to be an annotated tag and will use the first line of the annotation as the release name.

There are two extra cases that should be supported I think:

  1. A release with release notes, but without a release name.
  2. A release without a name or release notes.

I think the following could work:

  • If there is an annotated tag, it has a non-empty first line, and no second line, then it's a named release without notes.
  • If there is an annotated tag, it has a non-empty first line, an an empty second line, and a non-empty third line, then it's a named release with notes.
  • If there is an annotated tag, with a non-empty first line and a non-empty second line, then it is an unnamed release with release notes.
  • If there is no annotated tag (i.e. a lightweight tag), then it is an unnamed release without release notes.

This isn't airtight, since someone could be writing release notes on a single line without line breaks, and it would end up as a release name instead. We could do some shenanigans of checking the length of the first line, and anything above 50 is considered to be an unnamed release with notes.

@JeanMertz JeanMertz added the enhancement New feature or request label Aug 12, 2019
@JeanMertz
Copy link
Member Author

Partially resolved in 6b79f87. The only thing left is to support unnamed release with release notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Development

No branches or pull requests

1 participant