[flink-shaded] Some suggestions for improvements

[Stephan Ewen]

A few comments what we can improve in future releases:

  - I agree with Robert's comment to change the versioning to the same
model as Flink where the master branch is on a SNAPSHOT version always and
the releases are branches/tags with stable versions.

  - The version names of the artifacts read a bit
strange: flink-shaded-asm-5-1.0-5.0.4
  - I would suggest to rename them to something like
flink-shaded-asm_5.0.4-1.0
  - The version of the artifact with an underscore, so separate artifact
version from release version. Think of it as similar to the Scala version
specific release artifacts.

  - I would suggest to also remove the "tools" directly from the source
release, if that is not too much work.

[Chesnay Schepler-3]

I agree that the version scheme in the artifact isn't ideal.

We can keep the tools out of the release, but not in a nice way.
We either

 1. remove it in a separate commit before each release
 2. just omit it during the release process.

1) has the odd downside that the release branch cannot release itself,
as the script is now missing
2) has the odd downside that no branch in the repository would actually
match the release

As for the SNAPSHOT suffix, given that we currently don't do any
snapshot deployments
for flink-shaded, nor there being a reason for that in the first place
since the only a consumer
for the dependencies (aka Apache Flink) would never rely on SNAPSHOT
versions (I guess),
I don't see a the need for it. But i don't feel strongly about this, and
don't mind either way.

On 23.07.2017 15:42, Stephan Ewen wrote:

> A few comments what we can improve in future releases:
>
>    - I agree with Robert's comment to change the versioning to the same
> model as Flink where the master branch is on a SNAPSHOT version always and
> the releases are branches/tags with stable versions.
>
>    - The version names of the artifacts read a bit
> strange: flink-shaded-asm-5-1.0-5.0.4
>    - I would suggest to rename them to something like
> flink-shaded-asm_5.0.4-1.0
>    - The version of the artifact with an underscore, so separate artifact
> version from release version. Think of it as similar to the Scala version
> specific release artifacts.
>
>    - I would suggest to also remove the "tools" directly from the source
> release, if that is not too much work.
>

[Stephan Ewen]

For the SNAPSHOT part, I do not feel too strong about that either, just a
tendency to keep it in sync with how core Flink works.

For the "tools" directory, we can keep it as it is. It seems to complicated
and really is not a big deal...

On Sun, Jul 23, 2017 at 8:31 PM, Chesnay Schepler <[hidden email]>
wrote:

> I agree that the version scheme in the artifact isn't ideal.
>
> We can keep the tools out of the release, but not in a nice way.
> We either
>
> 1. remove it in a separate commit before each release
> 2. just omit it during the release process.
>
> 1) has the odd downside that the release branch cannot release itself, as
> the script is now missing
> 2) has the odd downside that no branch in the repository would actually
> match the release
>
> As for the SNAPSHOT suffix, given that we currently don't do any snapshot
> deployments
> for flink-shaded, nor there being a reason for that in the first place
> since the only a consumer
> for the dependencies (aka Apache Flink) would never rely on SNAPSHOT
> versions (I guess),
> I don't see a the need for it. But i don't feel strongly about this, and
> don't mind either way.
>
>
> On 23.07.2017 15:42, Stephan Ewen wrote:
>
>> A few comments what we can improve in future releases:
>>
>>    - I agree with Robert's comment to change the versioning to the same
>> model as Flink where the master branch is on a SNAPSHOT version always and
>> the releases are branches/tags with stable versions.
>>
>>    - The version names of the artifacts read a bit
>> strange: flink-shaded-asm-5-1.0-5.0.4
>>    - I would suggest to rename them to something like
>> flink-shaded-asm_5.0.4-1.0
>>    - The version of the artifact with an underscore, so separate artifact
>> version from release version. Think of it as similar to the Scala version
>> specific release artifacts.
>>
>>    - I would suggest to also remove the "tools" directly from the source
>> release, if that is not too much work.
>>
>>
>

[Chesnay Schepler-3]

I've opened a PR to adjust the artifact names:
https://github.com/apache/flink-shaded/pull/17

Under the new scheme the asm artifact would be named
"flink-shaded-asm-5.0.4-1.0"

By default maven concatenates the artifactId and version with a dash,
hence no underscore.

On 23.07.2017 21:37, Stephan Ewen wrote:

> For the SNAPSHOT part, I do not feel too strong about that either, just a
> tendency to keep it in sync with how core Flink works.
>
> For the "tools" directory, we can keep it as it is. It seems to complicated
> and really is not a big deal...
>
> On Sun, Jul 23, 2017 at 8:31 PM, Chesnay Schepler <[hidden email]>
> wrote:
>
>> I agree that the version scheme in the artifact isn't ideal.
>>
>> We can keep the tools out of the release, but not in a nice way.
>> We either
>>
>> 1. remove it in a separate commit before each release
>> 2. just omit it during the release process.
>>
>> 1) has the odd downside that the release branch cannot release itself, as
>> the script is now missing
>> 2) has the odd downside that no branch in the repository would actually
>> match the release
>>
>> As for the SNAPSHOT suffix, given that we currently don't do any snapshot
>> deployments
>> for flink-shaded, nor there being a reason for that in the first place
>> since the only a consumer
>> for the dependencies (aka Apache Flink) would never rely on SNAPSHOT
>> versions (I guess),
>> I don't see a the need for it. But i don't feel strongly about this, and
>> don't mind either way.
>>
>>
>> On 23.07.2017 15:42, Stephan Ewen wrote:
>>
>>> A few comments what we can improve in future releases:
>>>
>>>     - I agree with Robert's comment to change the versioning to the same
>>> model as Flink where the master branch is on a SNAPSHOT version always and
>>> the releases are branches/tags with stable versions.
>>>
>>>     - The version names of the artifacts read a bit
>>> strange: flink-shaded-asm-5-1.0-5.0.4
>>>     - I would suggest to rename them to something like
>>> flink-shaded-asm_5.0.4-1.0
>>>     - The version of the artifact with an underscore, so separate artifact
>>> version from release version. Think of it as similar to the Scala version
>>> specific release artifacts.
>>>
>>>     - I would suggest to also remove the "tools" directly from the source
>>> release, if that is not too much work.
>>>
>>>