...
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.
- Go to the StreamPipes release overview the following repository and follow the instructions (https://github.com/apache/streampipes/releases)
- Click on
Draft a new release
- Select the target rel branch as target and create a new tag with a random name (we won't save this release for now)
- Click on
Generate release notes
- As a next step, click on
Release Notes
link below the heading. - As the final step, paste the changes at the top of the
RELEASE_NOTES.md
like below, commit and push the changes.
Image Removed
- dominikriemer/jira-to-issues)
- Copy the release notes printed to the console and insert it into the release notes
Code Block |
---|
|
Code Block |
---|
language | xml |
---|
theme | Confluence |
---|
title | Release Notes Example |
---|
linenumbers | true |
---|
|
# 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> |
...
Code Block |
---|
language | bash |
---|
title | Update 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 Use the update version script to change version of the installer (directory: installer)
Code Block |
---|
language | bash |
---|
title | Create release branchChange version to release version of installers |
---|
|
# change version to next release version
./upgrade_versions.sh NEW_RELEASE_VERSION
# ./upgrade_versions.sh 0.69.0
# Commit and push these changes to rel/VERSION |
...
Code Block |
---|
language | bash |
---|
title | Upload files to SVN |
---|
|
# Create a new rc folder in the SVN (https://dist.apache.org/repos/dist/dev/streampipes)
# 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
- The sha512 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 |
---|
|
TO: dev@streampipes.apache.org
SUBJECT: [VOTE] Apache StreamPipes 0.90.0 RC1 release
TEXT: Apache StreamPipes 0.90.0 has been staged and it’s time to vote on accepting it for release. 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!
One artifact is relevant for this vote:
streampipes, staged at [1], available in Nexus at [2], release tag: release/0.90.0, hash for the release tag: 6893604222cb9c3efc4bf66dc0c21e3223c2c84e
Per [3] "Before voting +1, 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 [4]. The KEYS file is available at [5]
[ ] +1 accept (indicate what you validated - e.g. performed the checklist at the end of [4]) [ ] -1 reject (explanation required)
|
...
Cancel a vote
- If problems occur during the VOTE cancel the VOTE and prepare a new release candidate
...
...
Announce vote result
After 72 hours, the vote can be closed. Sometimes it might be worth to wait a little longer to allow all IPMC members to vote accordingly. If votes are missing, you can also directly approach people from the PPMC and ask for their vote.
Send the following mail to the dev list to announce the results:
...
...
The vote PASSES with X votes +1 (X binding/Y non-binding) and no -1.
...
Vote on Incubator list
Code Block |
---|
|
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/hmx9wtyjw6tqbx70gpvnr8tqcg0xxlcc
Vote: https://lists.apache.org/thread/b58pym522yqn4qbdym549xh440boy52p
From the PPMC vote, we carry over 1 binding IPMC votes:
Christofer Dutz
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)
One artifacts is 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: 6893604222cb9c3efc4bf66dc0c21e3223c2c84e
Per [3] "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 [4]. The KEYS file is available at [5]
Thanks for taking your time for validating this release!
[1
[1] https://dist.apache.org/repos/dist/dev/streampipes/0.90.0/rc1/ [2] https://distrepository.apache.org/repos/dist/dev/incubator/streampipes/0.69.0/rc1/
[2/content/repositories/orgapachestreampipes-1016 [3] https://www.apache.org/dev/release.html#approving-a-release [4] https://cwiki.apache.org/confluence/display/STREAMPIPES/Validating+a+release [5] https://repositorydownloads.apache.org/content/repositories/orgapachestreampipes-1016
[3] https://www.apache.org/dev/release.html#approving-a-release
[4] https://cwiki.apache.org/confluence/display/STREAMPIPES/Validating+a+release
[5] https://downloads.apache.org/incubator/streampipes/KEYS |
Publish vote result to Incubator list
Cancel a vote
- If problems occur during the VOTE cancel the VOTE and prepare a new release candidate
Panel |
---|
|
TO: dev@streampipes.apache.org
SUBJECT: [CANCEL][VOTE] Apache StreamPipes 0.90.0 RC1 release
TEXT:
Add description of the problem and how to resolve it. |
Announce vote result
After 72 hours, the vote can be closed. Sometimes it might be worth to wait a little longer to allow all PMC members to vote accordingly. If votes are missing, you can also directly approach people from the PMC and ask for their vote.
Send the following mail to the dev list to announce the results:
Panel |
---|
|
Code Block |
---|
title | IPMC Vote Result Mail |
---|
|
TO:
general@incubator dev@streampipes.apache.org
SUBJECT:
[RESULT][VOTE] Release Apache StreamPipes 0.69.0 (incubating)
RC1 release
TEXT:
Hi all,
The
the vote is tonow releaseclosed Apacheafter StreamPipesthe (incubating) 0.69.072h period has passed. The vote PASSES with X threevotes +1 (X binding/Y non-binding) and no -1.
+1 (binding) List
+1 (non-binding) List
Vote thread: LINK_TO_VOTE_THREAD
votes.
Binding votes:
Christofer Dutz
Julian Feinauer
Justin Mclean
Vote thread:
https://lists.apache.org/thread.html/r451a554230a558e3035c4d1c870591d50c2cadf00c36b0f9ba4a4616%40%3Cgeneral.incubator.apache.org%3E
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
|