maven-release icon indicating copy to clipboard operation
maven-release copied to clipboard

[MRELEASE-1089] Reduce the default tag format to the project version only

Open michael-o opened this issue 3 years ago • 10 comments
trafficstars

This closes #122

Following this checklist to help us incorporate your contribution quickly and easily:

  • [x] Make sure there is a JIRA issue filed for the change (usually before you start working on it). Trivial changes like typos do not require a JIRA issue. Your pull request should address just this issue, without pulling in other changes.
  • [x] Each commit in the pull request should have a meaningful subject line and body.
  • [x] Format the pull request title like [MJAVADOC-XXX] - Fixes bug in ApproximateQuantiles, where you replace MJAVADOC-XXX with the appropriate JIRA issue. Best practice is to use the JIRA issue title in the pull request title and in the first line of the commit message.
  • [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • [x] Run mvn clean verify -Prun-its to make sure basic checks pass. A more thorough check will be performed on your pull request automatically.

If your pull request is about ~20 lines of code you don't need to sign an Individual Contributor License Agreement if you are unsure please ask on the developers list.

To make clear that you license your contribution under the Apache License Version 2.0, January 2004 you have to acknowledge this by using the following check-box.

michael-o avatar May 07 '22 19:05 michael-o

Will similar be applied to https://github.com/apache/maven-release/blob/8cc2f45c2f424b176a45afc1e245639d56f31048/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultNamingPolicy.java#L34-L44?

pzygielo avatar May 07 '22 19:05 pzygielo

Will similar be applied to

https://github.com/apache/maven-release/blob/8cc2f45c2f424b176a45afc1e245639d56f31048/maven-release-manager/src/main/java/org/apache/maven/shared/release/policies/DefaultNamingPolicy.java#L34-L44 ?

Oh, very nice catch... Yes, it should be consistent throughout, no?

michael-o avatar May 07 '22 19:05 michael-o

@pzygielo Done. Thank you!

michael-o avatar May 07 '22 19:05 michael-o

please everywhere (even the commit message), please rephrase "reduce the tag format" to "reduce the default tag format"

on changing the default, I don't like it because it has implicit effect

I'd better add an explicit page showing how to change the tag name

hboutemy avatar May 08 '22 09:05 hboutemy

please everywhere (even the commit message), please rephrase "reduce the tag format" to "reduce the default tag format"

on changing the default, I don't like it because it has implicit effect

I'd better add an explicit page showing how to change the tag name

Done.

michael-o avatar May 08 '22 12:05 michael-o

I would also not change the default but rather document only how to change it. Changing it will lead to regressions for some users, where multiple releases are triggered from the same repo.

kwin avatar May 13 '22 12:05 kwin

I would also not change the default but rather document only how to change it. Changing it will lead to regressions for some users, where multiple releases are triggered from the same repo.

It is a major version after all and we'd provide an update documentation for this. Conventions change. If people blindly update and don't check the changelog means we will never be able to move forward.

@cstamas

michael-o avatar May 13 '22 13:05 michael-o

The old default may be too verbose but will IMHO never lead to a release failure while the new proposed default may fail. Therefore I consider the old default better!

kwin avatar May 13 '22 13:05 kwin

i’d like to second keeping the old format as default. we rely on this format for other tooling and needing to make changes on either side would be cumbersome.

jgangemi avatar May 13 '22 13:05 jgangemi

The old default may be too verbose but will IMHO never lead to a release failure while the new proposed default may fail. Therefore I consider the old default better!

That is an argument. I will on docs before I will consider this.

michael-o avatar May 13 '22 14:05 michael-o