Prepare release candidates

incubator-streampipes

First, set sp.version in the Maven archetypes to the upcoming release version of StreamPipes:

# In all subdirectories of archetypes, open the pom.xml file in src/main/resources/archetype-resources and set the sp.version property to the upcoming version (e.g., 0.66.0)

# Commit and push these changes to rel/VERSION

Update the UI version manually to the upcoming version:

# Update the version in ui/package.json

Now it's time to perform the Maven release!

Make sure to checkout a clean copy of incubator-streampipes and perform the following:

mvn release:prepare -DautoVersionSubmodules=true -Papache-release

The release plugin will ask you a few things:

1. The version we want to release as (It will suggest the version you get by omitting the -SNAPSHOT suffix)

2. The name of the tag the release commit will be tagged with in the SCM (Name it release/{release-version} (e.g., release/0.66.0 )

3. The next development version (The version present in the pom after the release) (e.g., 0.66.1-SNAPSHOT, use the next patch version and not the new minor version in dev)

Once this is finished, check that everything is correct: There should be a new tag release/version (e.g., release/0.66.0) which doesn't have any SNAPSHOT dependencies. In addition, your rel/VERSION branch should be increased to the next patch version.

Great! So the next step is to actually perform the release and stage the artifacts to the ASF Nexus. The command you need to run is:

mvn release:perform -DreleaseProfiles=apache-release

Uploading the artifacts to the ASF Nexus might take some time. Once it is finished, go to https://repository.apache.org, log in with your Apache credentials, go to "Staging Repositories" and search for "streampipes".

There should be one item in the list containing the just uploaded files. Click on "Close" and enter a message (e.g., Close StreamPipes release VERSION) and then you are done on the Maven side!

The final step is to upload the source release artifacts to the Apache SVN:

# Create a new rc folder in the SVN (https://dist.apache.org/repos/dist/dev/incubator/streampipes/core/)
# Create a new directory for the version (e.g., 0.66.0) and a new subdirectory for the release candidate (which is increased for every failed release), e.g., rc1.

# The folder structure should look like this:

-core
  - 0.66.0
     - rc1
-extensions
-installer
 

# Copy the following files into this folder (they can be found in incubator-streampipes/target/checkout/target:
- RELEASE_NOTES.md
- RELEASE_VALIDATION.md
- README.md
- The zip file (apache-streampipes-VERSION-incubating-source-release.zip)
- The asc file
- The sha512 file

# Commit these changes to SVN.

Great! The core module is ready for release voting.

incubator-streampipes-extensions

As the dependencies required by the extensions from incubator-streampipes are not yet available in Maven Central, we first need to manually install these dependencies locally:

# in incubator-streampipes/target/checkout (make sure the version is the release version (e.g., 0.66.0)

mvn clean install

Now switch to the incubator-streampipes-extensions project, make sure you are in the release branch (e.g., rel/0.66.0) and edit your pom.xml to make sure it uses the release version of all core modules:

# in incubator-streampipes-extensions/pom.xml

# Change the parent to the StreamPipes core release version:

<parent>
        <groupId>org.apache.streampipes</groupId>
        <artifactId>streampipes-parent</artifactId>
        <version>0.66.0</version>
    </parent>

# Change the streampipes.version property to the core release version:

<streampipes.version>0.66.0</streampipes.version>

The next step is to prepare the release with the following command (make sure to do this in a fresh local copy)

mvn release:prepare -DautoVersionSubmodules=true -Papache-release

Afterwards, finish the release. The deployment to a Maven repository is skipped, as the binary artifacts are all fat jars that are not intended for distribution via Maven.

mvn release:perform -DreleaseProfiles=apache-release

Great!

Now you can go to target/checkout/target and copy the dependencies to the Apache SVN. The Apache SVN directory is "extensions", the steps are equal to the steps described for the core module.

incubator-streampipes-installer

The preparation of a release candidate for incubator-streampipes-installer is a manual process:

Modify versions

# in branch rel/VERSION 
# open cli/tmpl_env and increase the SP_BACKEND_VERSION and SP_PE_VERSION to the release version, so that it looks like this:

SP_DOCKER_REGISTRY=apachestreampipes/
SP_BACKEND_VERSION=0.66.0
SP_PE_VERSION=0.66.0
HOST_DOCKER_INTERNAL=##HOST_DOCKER_INTERNAL##

# open helm-chart/values.yaml and increase the streampipes version in the streampipes block like this:

streampipes:
  version: "0.66.0"
  registry: "apachestreampipes"

# open installer/templates/.env and set SP_VERSION to the release version:

SP_VERSION=0.66.0
SP_DOCKER_REGISTRY=apachestreampipes
COMPOSE_PROJECT_NAME=streampipes

# commit and push the changes to the release branch

Create release candidate tag

git tag release/VERSION

#e.g., git tag release/0.66.0

# push tags
git push origin --tags

The next step is to create a zip file for the source release:

zip -r apache-streampipes-installer-VERSION-incubating.zip incubator-streampipes-installer

# e.g.:
zip -r apache-streampipes-installer-0.66.0-incubating.zip incubator-streampipes-installer/

Do a quick check if the source release contains any binary files, SNAPSHOT dependencies or other things that should not be part of the release. (e.g.,  grep -rnw './' -e 'SNAPSHOT')

Now we'll create a GPG signature:

gpg --detach-sign -a -u GPG_KEY apache-streampipes-installer-VERSION.zip

# e.g.:
gpg --detach-sign -a -u CA110DC0 apache-streampipes-installer-0.66.0-incubating.zip

# enter your passphrase when asked

The next step is to create a checksum:

sha512sum apache-streampipes-installer-VERSION-incubating.zip > apache-streampipes-installer-VERSION-incubating.zip.sha512

# e.g.:
sha512sum apache-streampipes-installer-0.66.0-incubating.zip > apache-streampipes-installer-0.66.0-incubating.zip.sha512

Now we are ready to prepare the release candidate in the Apache SVN:

# Create a new rc folder in the SVN (https://dist.apache.org/repos/dist/dev/incubator/streampipes/installer/)
# Create a new directory for the version (e.g., 0.66.0) and a new subdirectory for the release candidate (which is increased for every failed release), e.g., rc1.

# The folder structure should look like this:

-core
-extensions
-installer
 -0.66.0
   -rc1

Copy the following files into this folder:
- RELEASE_NOTES.md
- RELEASE_VALIDATION.md
- README.md
- The zip file
- The asc file
- The sha512 file

# Commit these changes to SVN.

Initiate vote

Now comes the best part: You're ready to send the VOTE mail to the developer list!

Remember: As an incubating project, two votes are required: First, the Apache StreamPipes community triggers a vote - once this vote is successful, a second vote will happen on the incubator list. But one step after the other - now let's write the mail targeted at our developer list at dev@streampipes.apache.org:

TO: 
dev@streampipes.apache.org 

SUBJECT: 
[VOTE] Apache StreamPipes 0.66.0 (incubating) RC1 release 

TEXT: 
Apache StreamPipes (Incubating) 0.66.0 has been staged and it’s time to vote on accepting it for release. 
If approved, we will seek final release approval from the IPMC. Voting will be open for 72 hours. 
A minimum of 3 binding +1 votes and more binding +1 than binding -1 are required to pass. 

Three artifacts are relevant for this vote: 

incubator-streampipes, staged at [1], available in Nexus at [2], release tag: release/0.66.0, hash for the release tag: b8c23e6785eaad79da6dd03072f2c1dcbfa467b4
incubator-streampipes-extensions, staged at [3], release tag: release/0.66.0, hash for the release tag: 44b7dd13c75058811a001f1aa6b3f6805285eb2d
incubator-streampipes-installer, staged at [4], release tag: release/0.66.0, hash for the release tag: 1a8054239d8f42d66ee95e7b1282708f5f1266b0

Per [5] "Before voting +1, [P]PMC members are required to download the signed source code package, 
compile it as provided, and test the resulting executable on their own platform, 
along with also verifying that the package meets the requirements of the ASF policy on releases." 

A release validation guide is available at [6]. The KEYS file is available at [7] 

[ ] +1 accept (indicate what you validated - e.g. performed the checklist at the end of [6]) 
[ ] -1 reject (explanation required) 

Thanks for taking your time for validating this release!


[1] https://dist.apache.org/repos/dist/dev/incubator/streampipes/core/0.66.0/rc1 
[2] https://repository.apache.org/content/repositories/orgapachestreampipes-1006 
[3] https://dist.apache.org/repos/dist/dev/incubator/streampipes/extensions/0.66.0/rc1 
[4] https://dist.apache.org/repos/dist/dev/incubator/streampipes/installer/0.66.0/rc1 
[5] https://www.apache.org/dev/release.html#approving-a-release 
[6] https://cwiki.apache.org/confluence/display/STREAMPIPES/Validating+a+release 
[7] https://dist.apache.org/repos/dist/dev/incubator/streampipes/KEYS

Deploy Maven artifacts to maven central

Move sources to release mirror in SVN

Cleanup older release sources

Add version to DOAP file

Merge release into master in all repos