...
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.
- Go to the StreamPipes issue tracker following repository and follow the instructions (https://issues.apache.org/jira/projects/STREAMPIPES/summary)
- Select the
Releases
menu on the left sidebar - Select the corresponding release. Now you should get displayed a list of all StreamPipes issues related to the current release.
- As a next step, click on
Release Notes
link below the heading. - The following page shows all issues grouped by their category. At the page's bottom you can find this list in HTML.
- Copy the HTML code and translate it to markdown (e.g., by an online translator tool or by using https://github.com/jgm/pandoc).
- As the final step, paste the changes at the top of the
RELEASE_NOTES.md
like below, commit and push the changes.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
# 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]
## Sub-task
* [[STREAMPIPES-xyz](https://issues.apache.org/jira/browse/STREAMPIPES-xyz)] - Some task description
## Bug
* [[STREAMPIPES-xzy](https://issues.apache.org/jira/browse/STREAMPIPES-xzy)] - Yet another task description |
Update issue template
Update the current version in the issue template for bug reports here.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
- 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
Info | ||
---|---|---|
| ||
It is recommended to use a clean repository for release preparation to ensure there are no unexpected local files in the source release. |
Make sure that you are in the branch rel/VERSION that you created earlier
First, set sp.version in the Maven archetypes to the upcoming release version of StreamPipes:
Code Block | ||||
---|---|---|---|---|
| ||||
# 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.69.0)
|
Update the UI version manually to the upcoming version:
Code Block | ||||
---|---|---|---|---|
| ||||
# Update the version in ui/package.json |
Use the update version script to change version of the installer (directory: installer)
Code Block | ||||
---|---|---|---|---|
| ||||
# 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 |
Now it's time to perform the Maven release!
- github.com/dominikriemer/jira-to-issues)
- Copy the release notes printed to the console and insert it into the release notes
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
# 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 | ||||||
---|---|---|---|---|---|---|
| ||||||
- 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
Info | ||
---|---|---|
| ||
It is recommended to use a clean repository for release preparation to ensure there are no unexpected local files in the source release. |
Make sure that you are in the branch rel/VERSION that you created earlier
First, set sp.version in the Maven archetypes to the upcoming release version of StreamPipes:
Code Block | ||||
---|---|---|---|---|
| ||||
# 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.69.0)
|
Update the UI version manually to the upcoming version:
Code Block | ||||
---|---|---|---|---|
| ||||
# 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)
Code Block | ||||
---|---|---|---|---|
| ||||
# 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 |
Now it's time to perform the Maven release!
Make sure to checkout a clean copy of incubator-streampipes and perform the following. Make sure you do this from the rel/VERSION branch!
Code Block | ||||
---|---|---|---|---|
| ||||
mvn release:prepare -DautoVersionSubmodules=true -Papache-release |
The release plugin will ask you a few things:
The version we want to release as (It will suggest the version you get by omitting the
-SNAPSHOT
suffix)The name of the tag the release commit will be tagged with in the SCM (Name it
release/{release-version}
(e.g.,release/0.69.0
)The next development version (The version present in the pom after the release) (e.g.,
0.69.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.69.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:Make sure to checkout a clean copy of incubator-streampipes and perform the following. Make sure you do this from the rel/VERSION branch!
Code Block | ||||
---|---|---|---|---|
| ||||
mvn release:prepareperform -DautoVersionSubmodulesDreleaseProfiles=true apache-Papache-release |
The release plugin will ask you a few things:
The version we want to release as (It will suggest the version you get by omitting the
-SNAPSHOT
suffix)The name of the tag the release commit will be tagged with in the SCM (Name it
release/{release-version}
(e.g.,release/0.69.0
)The next development version (The version present in the pom after the release) (e.g.,
0.69.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.69.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:
Code Block | ||||
---|---|---|---|---|
| ||||
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!
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 | ||||
---|---|---|---|---|
| ||||
# 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 | ||||
---|---|---|---|---|
| ||||
# Create a new rc folder in the SVN (https://dist.apache.org/repos/dist/dev/incubator/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
# Commit these changes to SVN. |
Great! StreamPipes is ready for release voting.
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:
...
title | Vote Mail |
---|
...
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!
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 | ||||
---|---|---|---|---|
| ||||
# 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 | ||||
---|---|---|---|---|
| ||||
# 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 streampipes/target/checkout/target:
- RELEASE_NOTES.md
- RELEASE_VALIDATION.md
- README.md
- The zip file (apache-streampipes-VERSION-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. |
Great! StreamPipes is ready for release voting.
Initiate vote
Now comes the best part: You're ready to send the VOTE mail to the developer list!
Panel | ||
---|---|---|
| ||
TO: |
...
Cancel a vote
- If problems occur during the VOTE cancel the VOTE and prepare a new release candidate
...
title | Vote Mail |
---|
...
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:
...
title | Vote Result Mail |
---|
...
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 |
Publish vote result to Incubator list
streampipes/KEYS |
Cancel a vote
- If problems occur during the VOTE cancel the VOTE and prepare a new release candidate
Panel | ||
---|---|---|
| ||
TO: |
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 | ||
| ||
TO: general@incubator The vote PASSES with X votes +1 (X binding/Y non-binding) and no -1.
|