Versions Compared

Key

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

...

Setup release branches
Anchor
setup-release-branches
setup-release-branches
 (Release Manager)

First, update the RELEASE_NOTES in incubator-streampipes (dev) by adding significant new features from JIRA that correspond to the new release version.

incubator-streampipes

Update active UI modules.

Depending on the features that should be released, the UI config for active modules needs to be updated. If the feature set changes, open the ui/deployment/rel/config.yml file and edit the list of active modules:

Code Block
languagebash
titleEdit active UI modules
login:
  backgroundImage: 'deployment/rel/img/background.png'
  logo: 'deployment/rel/img/logo.png'
  logo-right: 'deployment/rel/img/sp-logo-right-white.png'
modules:
  - spEditor
  - spPipelines
  - spConnect
  - spDashboard
  - spAppOverview
  - spAdd
  - spMyElements
  - spDataExplorer
  - spConfiguration

Commit and push these changes to dev

If needed, change the current SNAPSHOT version to the version that is planned for the upcoming release:

Set project version
# Make sure to only use a SNAPSHOT version here
# THIS STEP IS ONLY NEEDED IF THE NEXT RELEASE VERSION DIFFERS FROM THE CURRENT SNAPSHOT VERSION (e.g., when jumping from 0.90.0 to 0.95.0)
Code Block
languagebash
titleSet project version
# Make sure to only use a SNAPSHOT version here

mvn versions:set -DnewVersion=0.66.0-SNAPSHOT

# Check the output and briefly check if all changed version numbers in the POM files are ok

mvn versions:commit

# Manually change the project version in the package.json file in the ui/ folder.

# Push the changes to dev

...

The maven-release-plugin will ask you to provide the version number of the next development version (use the new minor version, not the suggested patch version). Afterwards, a new branch will be created and the version number in dev is increased to the next development version. All changes will be automatically pushed by the plugin.

In the dev branch, update the sp.version property in the maven archetypes (in the archetypes folder, all pom.xml templates in src/main/resources/archetype-resources)

Code Block
languagebash
titleUpdate sp.version in Maven archetypes
<properties>
<sp.version>0.66.0-SNAPSHOT</sp.version>
</properties>

Installer

Update the installer to the next development version in dev:

Code Block
languagebash
titleCreate release branch
# Go to incubator-streampipes/installer in dev

# checkout dev and update version
./upgrade_versions.sh NEW_SNAPSHOT_VERSION
git push origin


API Docs

Update the streampipes version within the API docs:

Code Block
languagebash
titleCreate release branch
# Go to /streampipes-backendservice-core/src/main/resources/openapi.yaml in dev

# adapt the streampipes version 
openAPI:
  info:
    version: '0.7091.0'


Checkout dev and change the aforementioned versions to the next release version (e.g., 0.67.0-SNAPSHOT)

...

In case modules are changed, update the docker-compose files in incubator-streampipes and incubator-streampipes-extensions streampipes project by adding/modifying/removing defined services.

...

  • JDK (starting from v0.70, JDK 11 17 is the new minimum java version)
  • Maven (tested with 3.6)
  • NodeJS + NPM (tested with v12+/ v6+)
  • Docker + Docker-Compose

...

First, create a new folder and checkout the release branches of incubator- streampipes:

Code Block
languagebash
titleCheckout release branches
# Clone & checkout a clean copy from the release branch

mkdir test-streampipes-rc && cd test-streampipes-rc
git clone git@github.com:apache/incubator-streampipes.git

# ALTERNATIVE: git clone https://github.com/apache/incubator-streampipes.git 

cd incubator-streampipes
# Change VERSION to the current release branch
git checkout rel/VERSION

...