Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info
titleYou are performing an Apache StreamPipes release for the first time?

Read the Onboarding Guide for Release Managers!


Table of Contents

Update release notes

IMPORTANT: This process did not work for the last release (0.92.0). I created an issue to fix it, see #1667).

To provide a proper overview of what has changed within the current release, we need to update file RELEASE_NOTES.md  in our release branch (rel/VERSION ).
Therefore it is required to perform the following steps.

  1. Go to the following repository and follow the instructions (https://github.com/dominikriemer/jira-to-issues)
  2. Copy the release notes printed to the console and insert it into the release notes


Code Block
languagexml
themeConfluence
titleRelease Notes Example
linenumberstrue
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

# [x.yy.z]


<GENERATED RELEASE NOTES>

Update issue template

Update the current version in the issue template for bug reports here.

Code Block
languageyml
titleBug Issue Teamplate
linenumberstrue
- type: dropdown
	attributes:
		label: Apache StreamPipes version
		description: What Apache StreamPipes version are you using?
		multiple: false
		options:
			- "0.70.0" # change to new release version
			- "dev (current development state)"
			- "Other StreamPipes version (please specify below)"

Prepare release candidates

...

Code Block
languagebash
titleUpdate UI version
# Update the version in ui/package.json
# Update the version in ui/package-lock.json (Be careful, this file contains two places with SNAPSHOT).

Use the update version script to change version of the installer (directory: installer)

...

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!


Revert Release

Important! Only when there was an error in the release. If this is the case, the maven release can be reverted with the following commands:

Code Block
languagebash
titleUpload files to SVN
# Drop artifacts in Nexus repository
- Go to https://repository.apache.org and login
- Go to "Staging Repositories" and search for "streampipes"
- There should be one item in the list containing the just uploaded files
- Click on "Drop" and enter a message

# Delete git tags, both locally and remote
- git tag -d release/#RELEASE_VERSION (e.g. git tag -d release/0.69.0)
- git push --delete origin release/#RELEASE_VERSION (e.g. git push --delete origin release/0.69.0)

# Rollback maven version
- mvn versions:set -DnewVersion=#OLD_DEVELOPMENT_VERSION (e.g. mvn versions:set -DnewVersion=0.60.0-SNAPSHOT
- Check that the version was changed correctly in all pom.xml files
- mvn versions:commit

# Commit changes in git
# Now the release process can be started again



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

...

Code Block
languagebash
titleUpload files to 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.69.0) and add release candidate (which is increased for every failed release), e.g., rc1.

# The folder structure should look like this:

- 0.69.0
	- rc1
 

# 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 (apache-streampipes-VERSION-source-release.zip.asc) 
- The sha512 file (apache-streampipes-VERSION-source-release.zip.sha512)

#  # Commit these changes to SVN.

...

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:


Panel
titleVote Mail
TO: 
dev@streampipes.apache.org

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

TEXT:
Apache StreamPipes (Incubating) 0.6990.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 at least 72 hours.
A minimum of 3 binding +1 votes and more binding +1 than binding -1 are required to pass, but everyone is welcome to vote!
Three
One artifactsartifact areis relevant for this vote:
incubator-
streampipes, staged at [1], available in Nexus at [2], release tag: release/0.6990.0, hash for the release tag: b8c23e6785eaad79da6dd03072f2c1dcbfa467b4
incubator-streampipes-extensions, staged at 6893604222cb9c3efc4bf66dc0c21e3223c2c84e

Per [3], release tag: release/0.69.0, hash for the release tag: 44b7dd13c75058811a001f1aa6b3f6805285eb2d
incubator-streampipes-installer, staged at [4], release tag: release/0.69.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 [64]. The KEYS file is available at [75]

[ ] +1 accept (indicate what you validated - e.g. performed the checklist at the end of [64])
[ ] -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.6990.0/rc1 /
[2] https://repository.apache.org/content/repositories/orgapachestreampipes-10061016
[3] https://dist.apache.org/repos/dist/dev/incubator/streampipes/extensions/0.69.0/rc1
[4] https://dist.apache.org/repos/dist/dev/incubator/streampipes/installer/0.69.0/rc1
[5] https://www.apache.org/dev/release.html#approving-a-release
[64] https://cwiki.apache.org/confluence/display/STREAMPIPES/Validating+a+release
[75] https://distdownloads.apache.org/repos/dist/dev/incubator/streampipes/KEYS

Cancel a vote

  • If problems occur during the VOTE cancel the VOTE and prepare a new release candidate
Panel
titleVote Mail
TO: 
dev@streampipes.apache.org

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

TEXT:

Add description of the problem and how to resolve it.

...

After 72 hours, the vote can be closed. Sometimes it might be worth to wait a little longer to allow all IPMC PMC members to vote accordingly. If votes are missing, you can also directly approach people from the PPMC PMC and ask for their vote.

Send the following mail to the dev list to announce the results:

Panel
titleVote Result Mail
TO: 
dev@streampipes.apache.org

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

TEXT:
Hi all,

the vote is now closed after the 72h period has passed.
Result (as per [1], only votes from IPMC members are binding):
The vote PASSES with X votes +1 (X binding/Y non-binding) and no -1.


+1 (binding)
List

+1 (non-binding)
List
I will now bring the vote to the IPMC to get final approval for release.
NAME
[1] https://incubator.apache.org/guides/ppmc.html#ppmc_and_binding_votes
Vote

...

Code Block
titleIPMC Vote Mail
TO: 
general@incubator.apache.org 

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

TEXT: 
Hi all,

this is a call for a vote to release Apache StreamPipes (incubating) 0.69.0.
Apache StreamPipes (incubating) is self-service Industrial IoT toolbox to enable non-technical users to connect, analyze and explore IIoT data streams.
The Apache StreamPipes community has voted on and approved a proposal to release Apache StreamPipes (incubating) 0.69.0

We now kindly request the Incubator PMC members to review and vote on this release.

Vote and result threads from the StreamPipes community:
Result: https://lists.apache.org/thread.html/rff5cbadf51c91b27f38fd5fb55b8b1d495c6e9f101c7552321e454e9%40%3Cdev.streampipes.apache.org%3E
Vote: https://lists.apache.org/thread.html/rbac494d62247beec29a6ced23a0deff528c46efe905828f1d8ec1a9a%40%3Cdev.streampipes.apache.org%3E

From the PPMC vote, we carry over 3 binding IPMC votes:
Christofer Dutz
Justin Mclean
Julian Feinauer

The vote will be open for at least 72 hours.

Please vote accordingly:

[] +1 approve (indicate what you validated - e.g., performed the checklist at [6])
[] +0 no opinion
[] -1 reject (explanation required)

Three artifacts are relevant for this vote: 

incubator-streampipes, staged at [1], available in Nexus at [2], release tag: release/0.69.0, hash for the release tag: b8c23e6785eaad79da6dd03072f2c1dcbfa467b4
incubator-streampipes-extensions, staged at [3], release tag: release/0.69.0, hash for the release tag: 44b7dd13c75058811a001f1aa6b3f6805285eb2d
incubator-streampipes-installer, staged at [4], release tag: release/0.69.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] 


Thanks for taking your time for validating this release!


[1] https://dist.apache.org/repos/dist/dev/incubator/streampipes/core/0.69.0/rc1 
[2] https://repository.apache.org/content/repositories/orgapachestreampipes-1006 
[3] https://dist.apache.org/repos/dist/dev/incubator/streampipes/extensions/0.69.0/rc1 
[4] https://dist.apache.org/repos/dist/dev/incubator/streampipes/installer/0.69.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

Publish vote result to Incubator list

Code Block
titleIPMC Vote Result Mail
TO: 
general@incubator.apache.org 

SUBJECT: 
[RESULT][VOTE] Release Apache StreamPipes 0.69.0 (incubating) 

TEXT: 
Hi all,

The vote to release Apache StreamPipes (incubating) 0.69.0 has passed with three +1 binding votes.

Binding votes:

Christofer Dutz
Julian Feinauer
Justin Mclean

Vote thread:
https://lists.apache.org/thread.html/r451a554230a558e3035c4d1c870591d50c2cadf00c36b0f9ba4a4616%40%3Cgeneral.incubator.apache.org%3E


: LINK_TO_VOTE_THREAD

Thanks a lot to everyone for taking your time to review our release candidate! We will proceed with publishing the approved artifacts and sending out the announcements in the coming days. On behalf of the Apache StreamPipes Community, NAME

NAME