You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by Michael Osipov <mi...@apache.org> on 2019/02/16 15:09:12 UTC

Git migration: new branch/tag naming scheme

Folks,

given that we are currently in the process of migrating to Git I'd like 
to propose a more readible and with the branch names consistent tag 
naming scheme.

The given approach, for whatsoever reason, performs an uppercase and 
replaces dots with underscores. This reduces readability, but also 
requires people (esp. package maintainers) to perform sed(1) magic to 
convert back and forth.

There are bascially two approaches I'd like to discuss:

Approch 1: It will reuse the branch name of the current major version, 
excluding master. Thus, we will have the following prefixes: tomcat90-, 
tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is 
released separately the prefix would be jdbc-pool-. The version itself 
would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.

Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another benefit 
would be autocompletion in Git CLI. I could simply say: "git checkout 
tomcat85" or "git checkout tomcat85-<TAB>" and grab the specific version 
I want.

Approach 2: A simpler, less redundant approach would be naming the 
branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix 
at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25, 
etc. The Git autocompletion will work here too.

I personally opt for approach 2 because it is consistent, concise and 
removes redundancy on always used prefixes.

Michael

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Christopher Schultz <ch...@christopherschultz.net>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

Mark,

On 2/18/19 05:03, Mark Thomas wrote:
> On 18/02/2019 09:13, Rémy Maucherat wrote:
>> On Sat, Feb 16, 2019 at 4:09 PM Michael Osipov
>> <mi...@apache.org> wrote:
>> 
>>> Folks,
>>> 
>>> given that we are currently in the process of migrating to Git
>>> I'd like to propose a more readible and with the branch names
>>> consistent tag naming scheme.
>>> 
>>> The given approach, for whatsoever reason, performs an
>>> uppercase and replaces dots with underscores. This reduces
>>> readability, but also requires people (esp. package
>>> maintainers) to perform sed(1) magic to convert back and
>>> forth.
>>> 
>>> There are bascially two approaches I'd like to discuss:
>>> 
>>> Approch 1: It will reuse the branch name of the current major
>>> version, excluding master. Thus, we will have the following
>>> prefixes: tomcat90-, tomcat85-, and tomcat70-. Since JDBC Pool
>>> remains in place and if it is released separately the prefix
>>> would be jdbc-pool-. The version itself would remain as-is and
>>> simply appended, e.g., 8.5.40, 9.0.25, etc.
>>> 
>>> Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another
>>> benefit would be autocompletion in Git CLI. I could simply say:
>>> "git checkout tomcat85" or "git checkout tomcat85-<TAB>" and
>>> grab the specific version I want.
>>> 
>>> Approach 2: A simpler, less redundant approach would be naming
>>> the branches master, 7.0.x, 8.5.x, etc. and get rid of the
>>> "tomcat" prefix at all. The tags would simply be the versions
>>> as-is: 8.5.40, 9.0.25, etc. The Git autocompletion will work
>>> here too.
>>> 
>>> I personally opt for approach 2 because it is consistent,
>>> concise and removes redundancy on always used prefixes.
>>> 
>> 
>> I guess it's hard to argue against option 2.
>> 
>> The main downside is that it comes late and Mark already did the
>> work and lots of testing for his proposed plan.
> 
> The current, community agreed proposal for branch naming is
> "master, tc8.5 and tc7.0"
> 
> There were strong views on the branch naming but "master, 8.5.x
> and 7.0.x" would be consistent with those views. I'm not sure I see
> much difference between either approach. If there is a strong
> preference for one over the other - or a good reason to choose one
> over the other - please make those views known in the next few
> days.
> 
> 
> The current proposal, community agreed proposal for tags is to
> continue with the current naming scheme. Switching to using the
> version as-is (9.0.1, 9.0.2, etc) is doable. It is just a little
> more work during the migration. If the as-is naming scheme makes it
> easier for downstream users then that strikes me as a good reason
> to change it. Are there any objections to doing so?

No objections, here.

- -chris
-----BEGIN PGP SIGNATURE-----
Comment: Using GnuPG with Thunderbird - https://www.enigmail.net/

iQIzBAEBCAAdFiEEMmKgYcQvxMe7tcJcHPApP6U8pFgFAlxrC9sACgkQHPApP6U8
pFiQ7g/9FwNkmK6aIGRCKIzeinQid1+umxHdOgobludzhnZcIObJKF9oALquyCgB
UivQfAU+Tcx1eoSwkKx7JDxq5MxkktfsKXzT9+L2eDfgMwyfaVjTtsq0Ia0Qmay6
OgDTspP95XZQlDoMhWNYS6zVqP/Yf4YIF6NxnA9ax+GGv6r4K6mED7oDbjHGXiq+
XqeFHibx0ynCai2L7S88UpIGiUWY70/l79+bZ3zOXfqmCRv4TotwuBoBh68RbYJB
A1x4VMs22OfuM9LF7K2kzAjtaEA4XNVn7sC1tYuwpr6LUx7gwlB1xB70F5oYiQlI
PhxYcSiFVnbiuROyU1cF1rOl6QuIQxhMYodABilEARrmoxk5vjG7f8ToOuUm0Wd1
yU02dt6B+rm3PHu5eFp5iRwHJiarYDFubO47Qwj0c+bkvn3R+u4XJ6CXMfV1j2SW
u7HjAjILU9iSAsVEIaYj04Ksv8A+6v6Czg4m/f8KWy+KX8nb50wfjfUiXfjdRB8m
saEOq03tjmlGfKipYPaNO3qUEP64S5EqJCyJj9acQ1ravd+8k1GteiUYuOWHFMzm
bNSAcb6YqKsqB//hSFRlIgsVTrr9/mx2FzhCzp/9a3RLzIsvA81Bxg6BHcJ91/cV
AVofdNE4X/WNsXoHDEx8FpgL/wCVbr3ODpt43SEv8f4XtsIrym0=
=gZ8p
-----END PGP SIGNATURE-----

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Michael Osipov <mi...@apache.org>.
Am 2019-02-18 um 11:03 schrieb Mark Thomas:
> On 18/02/2019 09:13, Rémy Maucherat wrote:
>> On Sat, Feb 16, 2019 at 4:09 PM Michael Osipov <mi...@apache.org> wrote:
>>
>>> Folks,
>>>
>>> given that we are currently in the process of migrating to Git I'd like
>>> to propose a more readible and with the branch names consistent tag
>>> naming scheme.
>>>
>>> The given approach, for whatsoever reason, performs an uppercase and
>>> replaces dots with underscores. This reduces readability, but also
>>> requires people (esp. package maintainers) to perform sed(1) magic to
>>> convert back and forth.
>>>
>>> There are bascially two approaches I'd like to discuss:
>>>
>>> Approch 1: It will reuse the branch name of the current major version,
>>> excluding master. Thus, we will have the following prefixes: tomcat90-,
>>> tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is
>>> released separately the prefix would be jdbc-pool-. The version itself
>>> would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.
>>>
>>> Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another benefit
>>> would be autocompletion in Git CLI. I could simply say: "git checkout
>>> tomcat85" or "git checkout tomcat85-<TAB>" and grab the specific version
>>> I want.
>>>
>>> Approach 2: A simpler, less redundant approach would be naming the
>>> branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix
>>> at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25,
>>> etc. The Git autocompletion will work here too.
>>>
>>> I personally opt for approach 2 because it is consistent, concise and
>>> removes redundancy on always used prefixes.
>>>
>>
>> I guess it's hard to argue against option 2.
>>
>> The main downside is that it comes late and Mark already did the work and
>> lots of testing for his proposed plan.
> 
> The current, community agreed proposal for branch naming is "master,
> tc8.5 and tc7.0"
> 
> There were strong views on the branch naming but "master, 8.5.x and
> 7.0.x" would be consistent with those views. I'm not sure I see much
> difference between either approach. If there is a strong preference for
> one over the other - or a good reason to choose one over the other -
> please make those views known in the next few days.
> 
> 
> The current proposal, community agreed proposal for tags is to continue
> with the current naming scheme. Switching to using the version as-is
> (9.0.1, 9.0.2, etc) is doable. It is just a little more work during the
> migration. If the as-is naming scheme makes it easier for downstream
> users then that strikes me as a good reason to change it. Are there any
> objections to doing so?

I'd be happy if we could clean that up..


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Igal Sapir <is...@apache.org>.
Mark,

On 2/20/2019 8:44 AM, Mark Thomas wrote:
> On 20/02/2019 16:14, Igal Sapir wrote:
>> Michael,
>>
>> On Mon, Feb 18, 2019 at 11:53 AM Michael Osipov <mi...@apache.org> wrote:
>>
>>> Am 2019-02-18 um 15:19 schrieb Igal Sapir:
>>>> <snip/>
>>>>
>>>> I actually prefer "tc8.5" and "tc7.0" for the branches (over "8.5.x" and
>>>> "7.0.x").  If tags will only use the numeric versions then this will make
>>>> it easy to differentiate between branches and tags.
>>> tc8.5 could also misread as 8.5 release. 8.5.x implies that this is in
>>> development. This a common scheme in many many repos.
>>> Where is the benefit keeping the prefix? Git autocompletion will stop at
>>> "8.5." and you choose either 'x' or a patch release.
>>>
>> If I want to switch branches, which is more often than switching to a tag
>> in my case, I would simply start with 't' without having to go through the
>> tags.
>>
>> Having to go through the tag options when I actually want to switch to a
>> branch is inefficient.
>>
>> Don't get me wrong, I don't care much which ones have a 'tc' prefix
>> (branches) and which do not (tags), I just like that there is a difference
>> between branches and tags.
> This got me thinking about how many key pressed would actually be
> required for branches
>
> Case A:
> Branches: 7.0.x, 8.5.x, master
> Tags: 7.0.11, 8.5.20, 9.0.12 etc.
>
> git checkout [7|8|m]<tab>
> master then auto-completes
> 7.0.x and 8.5.x get to "7.0." and "8.5." respectively and need a further
> "x" to complete.
>
> So that makes (ignoring the "git checkout ") 2 key presses for master
> and 3 for 7.0.x or 8.5.x
>
> Case B:
> Branches: tc7.0.x, tc8.5.x, master
> Tags: 7.0.11, 8.5.20, 9.0.12 etc.
>
> git checkout [t|m]<tab>
> master then auto-completes
> 7.0.x and 8.5.x both get to "tc" and need a further "7" or "8" and <tab>
> to complete.
>
> So that makes (ignoring the "git checkout ") 2 key presses for master
> and 4 for 7.0.x or 8.5.x
>
>
> Of course there are complications to this:
> - I suspect most developers will be using worktrees
> - keypresses are probably less important than how the GUIs of our
>    preferred tools handles this
>
>
> I think this comes down to whether it is worth using a prefix (tc) to
> (more clearly) differentiate release branches and tags in those places
> where the two appear together.
>
> To put it another way:
>
> Is "9.0.5 vs tc9.0.x" clearer than "9.0.5 vs 9.0.x"? And if it is, do we
> want that additional clarity?

I personally prefer and welcome that clarity, but TBH it's not a big 
deal either way.

I see myself mostly working on branches, and switching to tags only when 
I need to test a specific release.

Best,

Igal



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Michael Osipov <mi...@apache.org>.
Am 2019-02-20 um 17:44 schrieb Mark Thomas:
> On 20/02/2019 16:14, Igal Sapir wrote:
>> Michael,
>>
>> On Mon, Feb 18, 2019 at 11:53 AM Michael Osipov <mi...@apache.org> wrote:
>>
>>> Am 2019-02-18 um 15:19 schrieb Igal Sapir:
>>>> <snip/>
>>>>
>>>> I actually prefer "tc8.5" and "tc7.0" for the branches (over "8.5.x" and
>>>> "7.0.x").  If tags will only use the numeric versions then this will make
>>>> it easy to differentiate between branches and tags.
>>>
>>> tc8.5 could also misread as 8.5 release. 8.5.x implies that this is in
>>> development. This a common scheme in many many repos.
>>> Where is the benefit keeping the prefix? Git autocompletion will stop at
>>> "8.5." and you choose either 'x' or a patch release.
>>>
>>
>> If I want to switch branches, which is more often than switching to a tag
>> in my case, I would simply start with 't' without having to go through the
>> tags.
>>
>> Having to go through the tag options when I actually want to switch to a
>> branch is inefficient.
>>
>> Don't get me wrong, I don't care much which ones have a 'tc' prefix
>> (branches) and which do not (tags), I just like that there is a difference
>> between branches and tags.
> 
> This got me thinking about how many key pressed would actually be
> required for branches
> 
> Case A:
> Branches: 7.0.x, 8.5.x, master
> Tags: 7.0.11, 8.5.20, 9.0.12 etc.
> 
> git checkout [7|8|m]<tab>
> master then auto-completes
> 7.0.x and 8.5.x get to "7.0." and "8.5." respectively and need a further
> "x" to complete.
> 
> So that makes (ignoring the "git checkout ") 2 key presses for master
> and 3 for 7.0.x or 8.5.x
> 
> Case B:
> Branches: tc7.0.x, tc8.5.x, master
> Tags: 7.0.11, 8.5.20, 9.0.12 etc.
> 
> git checkout [t|m]<tab>
> master then auto-completes
> 7.0.x and 8.5.x both get to "tc" and need a further "7" or "8" and <tab>
> to complete.
> 
> So that makes (ignoring the "git checkout ") 2 key presses for master
> and 4 for 7.0.x or 8.5.x
> 
> 
> Of course there are complications to this:
> - I suspect most developers will be using worktrees
> - keypresses are probably less important than how the GUIs of our
>    preferred tools handles this

In a GUI it will show how clearly what is a branch or a tag. There 
shouldn't be any  ambiguity.

> I think this comes down to whether it is worth using a prefix (tc) to
> (more clearly) differentiate release branches and tags in those places
> where the two appear together.
> 
> To put it another way:
> 
> Is "9.0.5 vs tc9.0.x" clearer than "9.0.5 vs 9.0.x"? And if it is, do we
> want that additional clarity?

Fo me, it looks inconsistent. "9.0.5 vs 9.0.x" clearly says that the 
former is a fixed version whereas the latter is a moving target in 9.0.

I'd clearly opt for simplicity.

Michael

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Mark Thomas <ma...@apache.org>.
On 20/02/2019 16:14, Igal Sapir wrote:
> Michael,
> 
> On Mon, Feb 18, 2019 at 11:53 AM Michael Osipov <mi...@apache.org> wrote:
> 
>> Am 2019-02-18 um 15:19 schrieb Igal Sapir:
>>> <snip/>
>>>
>>> I actually prefer "tc8.5" and "tc7.0" for the branches (over "8.5.x" and
>>> "7.0.x").  If tags will only use the numeric versions then this will make
>>> it easy to differentiate between branches and tags.
>>
>> tc8.5 could also misread as 8.5 release. 8.5.x implies that this is in
>> development. This a common scheme in many many repos.
>> Where is the benefit keeping the prefix? Git autocompletion will stop at
>> "8.5." and you choose either 'x' or a patch release.
>>
> 
> If I want to switch branches, which is more often than switching to a tag
> in my case, I would simply start with 't' without having to go through the
> tags.
> 
> Having to go through the tag options when I actually want to switch to a
> branch is inefficient.
> 
> Don't get me wrong, I don't care much which ones have a 'tc' prefix
> (branches) and which do not (tags), I just like that there is a difference
> between branches and tags.

This got me thinking about how many key pressed would actually be
required for branches

Case A:
Branches: 7.0.x, 8.5.x, master
Tags: 7.0.11, 8.5.20, 9.0.12 etc.

git checkout [7|8|m]<tab>
master then auto-completes
7.0.x and 8.5.x get to "7.0." and "8.5." respectively and need a further
"x" to complete.

So that makes (ignoring the "git checkout ") 2 key presses for master
and 3 for 7.0.x or 8.5.x

Case B:
Branches: tc7.0.x, tc8.5.x, master
Tags: 7.0.11, 8.5.20, 9.0.12 etc.

git checkout [t|m]<tab>
master then auto-completes
7.0.x and 8.5.x both get to "tc" and need a further "7" or "8" and <tab>
to complete.

So that makes (ignoring the "git checkout ") 2 key presses for master
and 4 for 7.0.x or 8.5.x


Of course there are complications to this:
- I suspect most developers will be using worktrees
- keypresses are probably less important than how the GUIs of our
  preferred tools handles this


I think this comes down to whether it is worth using a prefix (tc) to
(more clearly) differentiate release branches and tags in those places
where the two appear together.

To put it another way:

Is "9.0.5 vs tc9.0.x" clearer than "9.0.5 vs 9.0.x"? And if it is, do we
want that additional clarity?


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Igal Sapir <ig...@lucee.org>.
Michael,

On Mon, Feb 18, 2019 at 11:53 AM Michael Osipov <mi...@apache.org> wrote:

> Am 2019-02-18 um 15:19 schrieb Igal Sapir:
> > <snip/>
> >
> > I actually prefer "tc8.5" and "tc7.0" for the branches (over "8.5.x" and
> > "7.0.x").  If tags will only use the numeric versions then this will make
> > it easy to differentiate between branches and tags.
>
> tc8.5 could also misread as 8.5 release. 8.5.x implies that this is in
> development. This a common scheme in many many repos.
> Where is the benefit keeping the prefix? Git autocompletion will stop at
> "8.5." and you choose either 'x' or a patch release.
>

If I want to switch branches, which is more often than switching to a tag
in my case, I would simply start with 't' without having to go through the
tags.

Having to go through the tag options when I actually want to switch to a
branch is inefficient.

Don't get me wrong, I don't care much which ones have a 'tc' prefix
(branches) and which do not (tags), I just like that there is a difference
between branches and tags.

Igal

Re: Git migration: new branch/tag naming scheme

Posted by Michael Osipov <mi...@apache.org>.
Am 2019-02-18 um 15:19 schrieb Igal Sapir:
> On Mon, Feb 18, 2019 at 2:03 AM Mark Thomas <ma...@apache.org> wrote:
> 
>> On 18/02/2019 09:13, Rémy Maucherat wrote:
>>> On Sat, Feb 16, 2019 at 4:09 PM Michael Osipov <mi...@apache.org>
>> wrote:
>>>
>>>> Folks,
>>>>
>>>> given that we are currently in the process of migrating to Git I'd like
>>>> to propose a more readible and with the branch names consistent tag
>>>> naming scheme.
>>>>
>>>> The given approach, for whatsoever reason, performs an uppercase and
>>>> replaces dots with underscores. This reduces readability, but also
>>>> requires people (esp. package maintainers) to perform sed(1) magic to
>>>> convert back and forth.
>>>>
>>>> There are bascially two approaches I'd like to discuss:
>>>>
>>>> Approch 1: It will reuse the branch name of the current major version,
>>>> excluding master. Thus, we will have the following prefixes: tomcat90-,
>>>> tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is
>>>> released separately the prefix would be jdbc-pool-. The version itself
>>>> would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.
>>>>
>>>> Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another benefit
>>>> would be autocompletion in Git CLI. I could simply say: "git checkout
>>>> tomcat85" or "git checkout tomcat85-<TAB>" and grab the specific version
>>>> I want.
>>>>
>>>> Approach 2: A simpler, less redundant approach would be naming the
>>>> branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix
>>>> at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25,
>>>> etc. The Git autocompletion will work here too.
>>>>
>>>> I personally opt for approach 2 because it is consistent, concise and
>>>> removes redundancy on always used prefixes.
>>>>
>>>
>>> I guess it's hard to argue against option 2.
>>>
>>> The main downside is that it comes late and Mark already did the work and
>>> lots of testing for his proposed plan.
>>
>> The current, community agreed proposal for branch naming is "master,
>> tc8.5 and tc7.0"
>>
> 
> That's fine by me.
> 
> 
>>
>> There were strong views on the branch naming but "master, 8.5.x and
>> 7.0.x" would be consistent with those views. I'm not sure I see much
>> difference between either approach. If there is a strong preference for
>> one over the other - or a good reason to choose one over the other -
>> please make those views known in the next few days.
>>
> 
> No good reason.  Based on the OP I thought that we are comparing to a more
> verbose scheme like "tomcat-90-xxx" (without the standard "master" branch).
> 
> I actually prefer "tc8.5" and "tc7.0" for the branches (over "8.5.x" and
> "7.0.x").  If tags will only use the numeric versions then this will make
> it easy to differentiate between branches and tags.

tc8.5 could also misread as 8.5 release. 8.5.x implies that this is in 
development. This a common scheme in many many repos.
Where is the benefit keeping the prefix? Git autocompletion will stop at 
"8.5." and you choose either 'x' or a patch release.

Michael


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Igal Sapir <ig...@lucee.org>.
On Mon, Feb 18, 2019 at 2:03 AM Mark Thomas <ma...@apache.org> wrote:

> On 18/02/2019 09:13, Rémy Maucherat wrote:
> > On Sat, Feb 16, 2019 at 4:09 PM Michael Osipov <mi...@apache.org>
> wrote:
> >
> >> Folks,
> >>
> >> given that we are currently in the process of migrating to Git I'd like
> >> to propose a more readible and with the branch names consistent tag
> >> naming scheme.
> >>
> >> The given approach, for whatsoever reason, performs an uppercase and
> >> replaces dots with underscores. This reduces readability, but also
> >> requires people (esp. package maintainers) to perform sed(1) magic to
> >> convert back and forth.
> >>
> >> There are bascially two approaches I'd like to discuss:
> >>
> >> Approch 1: It will reuse the branch name of the current major version,
> >> excluding master. Thus, we will have the following prefixes: tomcat90-,
> >> tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is
> >> released separately the prefix would be jdbc-pool-. The version itself
> >> would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.
> >>
> >> Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another benefit
> >> would be autocompletion in Git CLI. I could simply say: "git checkout
> >> tomcat85" or "git checkout tomcat85-<TAB>" and grab the specific version
> >> I want.
> >>
> >> Approach 2: A simpler, less redundant approach would be naming the
> >> branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix
> >> at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25,
> >> etc. The Git autocompletion will work here too.
> >>
> >> I personally opt for approach 2 because it is consistent, concise and
> >> removes redundancy on always used prefixes.
> >>
> >
> > I guess it's hard to argue against option 2.
> >
> > The main downside is that it comes late and Mark already did the work and
> > lots of testing for his proposed plan.
>
> The current, community agreed proposal for branch naming is "master,
> tc8.5 and tc7.0"
>

That's fine by me.


>
> There were strong views on the branch naming but "master, 8.5.x and
> 7.0.x" would be consistent with those views. I'm not sure I see much
> difference between either approach. If there is a strong preference for
> one over the other - or a good reason to choose one over the other -
> please make those views known in the next few days.
>

No good reason.  Based on the OP I thought that we are comparing to a more
verbose scheme like "tomcat-90-xxx" (without the standard "master" branch).

I actually prefer "tc8.5" and "tc7.0" for the branches (over "8.5.x" and
"7.0.x").  If tags will only use the numeric versions then this will make
it easy to differentiate between branches and tags.



>
> The current proposal, community agreed proposal for tags is to continue
> with the current naming scheme. Switching to using the version as-is
> (9.0.1, 9.0.2, etc) is doable. It is just a little more work during the
> migration. If the as-is naming scheme makes it easier for downstream
> users then that strikes me as a good reason to change it. Are there any
> objections to doing so?
>

Git tags are very lightweight, they are just pointers to other commits, so
if it's easier, we can do the migration as-is and then write some script to
generate new tags with the new naming convention, it shouldn't be too hard
IMO.  The old tags can remain or be removed at a later time.  They hardly
take any space.

Best,

Igal

Re: Git migration: new branch/tag naming scheme

Posted by Mark Thomas <ma...@apache.org>.
On 18/02/2019 09:13, Rémy Maucherat wrote:
> On Sat, Feb 16, 2019 at 4:09 PM Michael Osipov <mi...@apache.org> wrote:
> 
>> Folks,
>>
>> given that we are currently in the process of migrating to Git I'd like
>> to propose a more readible and with the branch names consistent tag
>> naming scheme.
>>
>> The given approach, for whatsoever reason, performs an uppercase and
>> replaces dots with underscores. This reduces readability, but also
>> requires people (esp. package maintainers) to perform sed(1) magic to
>> convert back and forth.
>>
>> There are bascially two approaches I'd like to discuss:
>>
>> Approch 1: It will reuse the branch name of the current major version,
>> excluding master. Thus, we will have the following prefixes: tomcat90-,
>> tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is
>> released separately the prefix would be jdbc-pool-. The version itself
>> would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.
>>
>> Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another benefit
>> would be autocompletion in Git CLI. I could simply say: "git checkout
>> tomcat85" or "git checkout tomcat85-<TAB>" and grab the specific version
>> I want.
>>
>> Approach 2: A simpler, less redundant approach would be naming the
>> branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix
>> at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25,
>> etc. The Git autocompletion will work here too.
>>
>> I personally opt for approach 2 because it is consistent, concise and
>> removes redundancy on always used prefixes.
>>
> 
> I guess it's hard to argue against option 2.
> 
> The main downside is that it comes late and Mark already did the work and
> lots of testing for his proposed plan.

The current, community agreed proposal for branch naming is "master,
tc8.5 and tc7.0"

There were strong views on the branch naming but "master, 8.5.x and
7.0.x" would be consistent with those views. I'm not sure I see much
difference between either approach. If there is a strong preference for
one over the other - or a good reason to choose one over the other -
please make those views known in the next few days.


The current proposal, community agreed proposal for tags is to continue
with the current naming scheme. Switching to using the version as-is
(9.0.1, 9.0.2, etc) is doable. It is just a little more work during the
migration. If the as-is naming scheme makes it easier for downstream
users then that strikes me as a good reason to change it. Are there any
objections to doing so?

Mark

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Rémy Maucherat <re...@apache.org>.
On Sat, Feb 16, 2019 at 4:09 PM Michael Osipov <mi...@apache.org> wrote:

> Folks,
>
> given that we are currently in the process of migrating to Git I'd like
> to propose a more readible and with the branch names consistent tag
> naming scheme.
>
> The given approach, for whatsoever reason, performs an uppercase and
> replaces dots with underscores. This reduces readability, but also
> requires people (esp. package maintainers) to perform sed(1) magic to
> convert back and forth.
>
> There are bascially two approaches I'd like to discuss:
>
> Approch 1: It will reuse the branch name of the current major version,
> excluding master. Thus, we will have the following prefixes: tomcat90-,
> tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is
> released separately the prefix would be jdbc-pool-. The version itself
> would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.
>
> Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another benefit
> would be autocompletion in Git CLI. I could simply say: "git checkout
> tomcat85" or "git checkout tomcat85-<TAB>" and grab the specific version
> I want.
>
> Approach 2: A simpler, less redundant approach would be naming the
> branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix
> at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25,
> etc. The Git autocompletion will work here too.
>
> I personally opt for approach 2 because it is consistent, concise and
> removes redundancy on always used prefixes.
>

I guess it's hard to argue against option 2.

The main downside is that it comes late and Mark already did the work and
lots of testing for his proposed plan.

Rémy


>
> Michael
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>

Re: Git migration: new branch/tag naming scheme

Posted by Konstantin Kolinko <kn...@gmail.com>.
пн, 18 февр. 2019 г. в 11:08, Emmanuel Bourg <eb...@apache.org>
>
> Le 16/02/2019 à 16:09, Michael Osipov a écrit :
>
> > The given approach, for whatsoever reason, performs an uppercase and
> > replaces dots with underscores. This reduces readability, but also
> > requires people (esp. package maintainers) to perform sed(1) magic to
> > convert back and forth.
>
> I agree this is cumbersome, we are doing this kind of manipulation in
> Debian too to compare the version packaged with the latest upstream release.
>

1. What do we do with RC and milestone release tags, e.g.
TOMCAT_7_0_0_RC4, TOMCAT_9_0_0_M27?

9.0.0.M27, 9.0.0-M27, 9.0.0_M27, or the same with lowercase 'm'?

Historically,
Tomcat 9 used a dot "9.0.0.M27" in announcements and in filenames [1][2],
Tomcat 8 used a dash "8.0.0-RC10" in announcements and filenames [3][4] .
Tomcat 7 used a "-beta" suffix in filenames [5].

Different downstream packagers (e.g. Maven, RPM) may have different
rules regarding handling and sorting such names. The '-' symbol may be
special.

[1] http://tomcat.apache.org/oldnews-2016.html
[2] https://archive.apache.org/dist/tomcat/tomcat-9/
[3] http://tomcat.apache.org/oldnews-2013.html
[4] https://archive.apache.org/dist/tomcat/tomcat-8/
[5] https://archive.apache.org/dist/tomcat/tomcat-7/

My preference is to stick with the current historical format of tag
names (TOMCAT_) and let downstream deal with proper parsing and
formatting of these numbers.

> to perform sed(1) magic

2. The prefix "TOMCAT_x_y_" is fixed in a particular branch and has
known length. I had processed similar strings with 'cut' utility [6].
This can also be processed by parameters substitution in shell [7].
Though somebody may call that magic as well.

[6] http://pubs.opengroup.org/onlinepubs/9699919799/utilities/cut.html
[7] http://pubs.opengroup.org/onlinepubs/9699919799/utilities/V3_chap02.html#tag_18_06_02

Best regards,
Konstantin Kolinko

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Emmanuel Bourg <eb...@apache.org>.
Le 16/02/2019 à 16:09, Michael Osipov a écrit :

> The given approach, for whatsoever reason, performs an uppercase and
> replaces dots with underscores. This reduces readability, but also
> requires people (esp. package maintainers) to perform sed(1) magic to
> convert back and forth.

I agree this is cumbersome, we are doing this kind of manipulation in
Debian too to compare the version packaged with the latest upstream release.

If I remember well this convention is inherited from the CVS era, dots
were not allowed in tag names and thus commonly replaced by underscores
or dashes.


> Approch 1: It will reuse the branch name of the current major version,
> excluding master. Thus, we will have the following prefixes: tomcat90-,
> tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is
> released separately the prefix would be jdbc-pool-. The version itself
> would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.

-0

> Approach 2: A simpler, less redundant approach would be naming the
> branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix
> at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25,
> etc. The Git autocompletion will work here too.

+1

Emmanuel Bourg

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Re: Git migration: new branch/tag naming scheme

Posted by Igal Sapir <ig...@lucee.org>.
Michael,

On Sat, Feb 16, 2019 at 7:09 AM Michael Osipov <mi...@apache.org> wrote:

> <snip/>
>
> There are bascially two approaches I'd like to discuss:
>
> Approch 1: It will reuse the branch name of the current major version,
> excluding master. Thus, we will have the following prefixes: tomcat90-,
> tomcat85-, and tomcat70-. Since JDBC Pool remains in place and if it is
> released separately the prefix would be jdbc-pool-. The version itself
> would remain as-is and simply appended, e.g., 8.5.40, 9.0.25, etc.
>
> Finally it would be tomcat85-8.5.40, tomcat90-9.0.25. Another benefit
> would be autocompletion in Git CLI. I could simply say: "git checkout
> tomcat85" or "git checkout tomcat85-<TAB>" and grab the specific version
> I want.
>
> Approach 2: A simpler, less redundant approach would be naming the
> branches master, 7.0.x, 8.5.x, etc. and get rid of the "tomcat" prefix
> at all. The tags would simply be the versions as-is: 8.5.40, 9.0.25,
> etc. The Git autocompletion will work here too.
>
> I personally opt for approach 2 because it is consistent, concise and
> removes redundancy on always used prefixes.
>

I also prefer the 2nd option.  Working with a "master" branch on Git is
much more "standard", and I'm always in favor of removing boilerplate that
is repeated over and over.

Best,

Igal



>
> Michael
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
>