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

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

michael-o
Copy link
Member

@michael-o michael-o commented May 7, 2022

This closes #122

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

  • 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.
  • Each commit in the pull request should have a meaningful subject line and body.
  • 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.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • 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.

@pzygielo
Copy link
Contributor

pzygielo commented May 7, 2022

Will similar be applied to

* @since 3.0.0-M5
*/
@Singleton
@Named
public class DefaultNamingPolicy implements NamingPolicy
{
@Override
public NamingPolicyResult getName( NamingPolicyRequest request )
throws PolicyException
{
return new NamingPolicyResult().setName( request.getArtifactId() + "-" + request.getVersion() );
?

@michael-o
Copy link
Member Author

Will similar be applied to

* @since 3.0.0-M5
*/
@Singleton
@Named
public class DefaultNamingPolicy implements NamingPolicy
{
@Override
public NamingPolicyResult getName( NamingPolicyRequest request )
throws PolicyException
{
return new NamingPolicyResult().setName( request.getArtifactId() + "-" + request.getVersion() );

?

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

@michael-o
Copy link
Member Author

@pzygielo Done. Thank you!

@hboutemy hboutemy changed the title [MRELEASE-1089] Reduce the tag format to the project version only [MRELEASE-1089] Reduce the default tag format to the project version only May 8, 2022
@hboutemy
Copy link
Member

hboutemy commented May 8, 2022

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

@michael-o
Copy link
Member Author

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.

@kwin
Copy link
Member

kwin commented May 13, 2022

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.

@michael-o
Copy link
Member Author

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

@kwin
Copy link
Member

kwin commented May 13, 2022

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!

@jgangemi
Copy link

jgangemi commented May 13, 2022

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.

@michael-o
Copy link
Member Author

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 michael-o marked this pull request as draft May 14, 2022 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants