You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by aljoscha <gi...@git.apache.org> on 2017/07/27 09:04:01 UTC
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
GitHub user aljoscha opened a pull request:
https://github.com/apache/flink/pull/4407
[FLINK-7281] Fix various issues in (Maven) release infrastructure
## What is the purpose of the change
Fix various issues in the release infrastructure and Maven.
## Brief change log
* remove old, misleading release scripts and release README
* configure the _maven-release-plugin_ for doing actual releases with it
* make the quickstarts depend on project versions
* configure _maven-javadoc-plugin_ to work with _maven-release-plugin_ (doc linting was not disabled)
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## Does this pull request potentially affect one of the following parts:
no
## Documentation
- Does this pull request introduce a new feature? (no)
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/aljoscha/flink release-1.3
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4407.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #4407
----
commit b37c29feb3814969031b573bc73dcd09c807744f
Author: Aljoscha Krettek <al...@gmail.com>
Date: 2017-07-25T13:07:59Z
[FLINK-7281] Remove old and misleading release scripts/README
commit 6d6b5289de72016ea65a4f869cda3ef58a26a5d4
Author: Aljoscha Krettek <al...@gmail.com>
Date: 2017-07-25T13:30:26Z
[FLINK-7281] Make quickstart versions depend on project versions
commit ded58c9bf0a21e5205d514e010b515b1ef1e7f2f
Author: Aljoscha Krettek <al...@gmail.com>
Date: 2017-07-25T13:30:42Z
[FLINK-7281] Bump maven-release-plugin version and make it work
commit 1a5cecab8f91cadbdd86c6194ef6276f1cc5df83
Author: Aljoscha Krettek <al...@gmail.com>
Date: 2017-07-26T10:10:15Z
[FLINK-7281] Move maven-javadoc-config out of execution blocks
commit 085852028837cf9d7835a6120385ea665e8510e3
Author: Aljoscha Krettek <al...@gmail.com>
Date: 2017-07-26T12:19:49Z
[FLINK-7281] Move maven-release-plugin out of release profile
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129808825
--- Diff: pom.xml ---
@@ -1246,14 +1247,32 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
- <version>2.1</version>
+ <version>2.5.3</version>
<configuration>
- <mavenExecutorId>forked-path</mavenExecutorId>
- <useReleaseProfile>false</useReleaseProfile>
- <arguments>${arguments} -Psonatype-oss-release</arguments>
+ <releaseProfiles>release</releaseProfiles>
+ <preparationGoals>clean install</preparationGoals>
+ <goals>deploy</goals>
+ <autoVersionSubmodules>true</autoVersionSubmodules>
+ <pushChanges>false</pushChanges>
</configuration>
</plugin>
+ <!-- Rename the artifact produced by the Apache parent's
+ source release. -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-assembly-plugin</artifactId>
--- End diff --
what would the name be without this?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129824585
--- Diff: pom.xml ---
@@ -1246,14 +1247,32 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
- <version>2.1</version>
+ <version>2.5.3</version>
<configuration>
- <mavenExecutorId>forked-path</mavenExecutorId>
- <useReleaseProfile>false</useReleaseProfile>
- <arguments>${arguments} -Psonatype-oss-release</arguments>
+ <releaseProfiles>release</releaseProfiles>
+ <preparationGoals>clean install</preparationGoals>
+ <goals>deploy</goals>
+ <autoVersionSubmodules>true</autoVersionSubmodules>
+ <pushChanges>false</pushChanges>
</configuration>
</plugin>
+ <!-- Rename the artifact produced by the Apache parent's
+ source release. -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-assembly-plugin</artifactId>
--- End diff --
Not, sure, actually. I'm setting it manually to make it resemble our current file naming.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #4407: [FLINK-7281] Fix various issues in (Maven) release infras...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on the issue:
https://github.com/apache/flink/pull/4407
the changes for FLINK-7281 look good.
As for FLINK-7290, you didn't adjust the existing release script. Do you intend to delete it or adjust it to call the module scripts? (There is after all no documentation on how to use the scripts, like their order)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129824175
--- Diff: pom.xml ---
@@ -1257,6 +1243,17 @@ under the License.
<pluginManagement>
<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-release-plugin</artifactId>
--- End diff --
We were actually not using this before, it was just a leftover in there. It's not even required for our release process, i.e. in the release profile.
However, the plugin can be used to do the stuff that we do in scripts and manually. For example , I can do
```
mvn release:branch \
-DbranchName=${BRANCH_NAME} \
-DdevelopmentVersion=${DEVELOPMENT_VERSION}
```
to update the version on master and fork of the branch for a newly released version.
Then I could use
```
mvn release:prepare \
-Dresume=false \
-DreleaseVersion=${VERSION} \
-Dtag=${TAG} \
-DupdateWorkingCopyVersions=false
```
and
```
mvn release:perform
```
to build the actual release, create the source release, upload the (signed) jars to sonatype and create the release tag.
(I was experimenting with this when preparing for the next release and our release infrastructure is very _interesting_.)
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129824759
--- Diff: tools/force-shading/pom.xml ---
@@ -93,11 +93,13 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
- <version>2.1</version>
+ <version>2.5.3</version>
<configuration>
- <mavenExecutorId>forked-path</mavenExecutorId>
- <useReleaseProfile>false</useReleaseProfile>
- <arguments>${arguments} -Psonatype-oss-release</arguments>
+ <releaseProfiles>release</releaseProfiles>
+ <preparationGoals>clean install</preparationGoals>
+ <goals>deploy</goals>
+ <autoVersionSubmodules>true</autoVersionSubmodules>
+ <pushChanges>false</pushChanges>
--- End diff --
`autoVersionSubmodules` tells it to update the version in all the submodules. `pushChanges` instructs it to not early push new branches, commits, tags to git. Otherwise it does that, which seems a bit crazy.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129808895
--- Diff: tools/force-shading/pom.xml ---
@@ -93,11 +93,13 @@ under the License.
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
- <version>2.1</version>
+ <version>2.5.3</version>
<configuration>
- <mavenExecutorId>forked-path</mavenExecutorId>
- <useReleaseProfile>false</useReleaseProfile>
- <arguments>${arguments} -Psonatype-oss-release</arguments>
+ <releaseProfiles>release</releaseProfiles>
+ <preparationGoals>clean install</preparationGoals>
+ <goals>deploy</goals>
+ <autoVersionSubmodules>true</autoVersionSubmodules>
+ <pushChanges>false</pushChanges>
--- End diff --
could you explain what the last 2 options do?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha closed the pull request at:
https://github.com/apache/flink/pull/4407
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129807756
--- Diff: pom.xml ---
@@ -1257,6 +1243,17 @@ under the License.
<pluginManagement>
<plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-release-plugin</artifactId>
--- End diff --
given that it is only defined in the plugin management section i was wondering whether we need this plugin at all.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #4407: [FLINK-7281] Fix various issues in (Maven) release infras...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on the issue:
https://github.com/apache/flink/pull/4407
@zentol Yes, I'm planning to remove the old script and the documentation for the new scripts is taking shape here: https://cwiki.apache.org/confluence/display/FLINK/Creating+a+Flink+Release
The scripts are not yet described there but I will fill this in as I go. I think it's already quite the improvement compared to the old release "guide": https://cwiki.apache.org/confluence/display/FLINK/Releasing
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #4407: [FLINK-7281] Fix various issues in (Maven) release infras...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on the issue:
https://github.com/apache/flink/pull/4407
@zentol I will remove some changes from this so that only the Quickstart changes remain and the removal of the old release script and README. I think using `maven-release-plugin` is currently not a good option so I will leave that as is. What do you think?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129824394
--- Diff: pom.xml ---
@@ -802,20 +802,6 @@ under the License.
</executions>
</plugin>
</plugins>
- <pluginManagement>
--- End diff --
As mentioned above, it's not actually needed for our current release process but I'd like to make it usable for that. Apparently how you use it with the Apache parent pom is to put it into the `pluginManagement` section.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #4407: [FLINK-7281] Fix various issues in (Maven) release infras...
Posted by aljoscha <gi...@git.apache.org>.
Github user aljoscha commented on the issue:
https://github.com/apache/flink/pull/4407
Merged
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #4407: [FLINK-7281] Fix various issues in (Maven) release...
Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:
https://github.com/apache/flink/pull/4407#discussion_r129808661
--- Diff: pom.xml ---
@@ -802,20 +802,6 @@ under the License.
</executions>
</plugin>
</plugins>
- <pluginManagement>
--- End diff --
what's the benefit of moving it out of the release profile? The profile still exists, and the plugin should only be used when making a release, no?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---