Versions Compared

Key

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

First of all, thanks for taking the time to validate an Apache StreamPipes (incubating) release!

The following steps should help you in performing the necessary steps to validate a release. Any comments or improvements to this guide are highly appreciated!

...

For fully testing a release candidate, you should have the following installed on your system:

  • JDK (tested with required: JDK 817+)
  • Maven (tested with 3.6)
  • NodeJS + NPM (tested with v12v16+/ v6v8+)
  • Docker + Docker-Compose

...

The artifacts are available at at https://dist.apache.org/repos/dist/dev/incubatorstreampipes/streampipes 

Typically, this includes one zip files along with checksum, signature, README, RELEASE_VALIDATION and RELEASE_NOTES.

...

Code Block
languagebash
titleDownload release artifacts
# download all release artifacts (core, extensions, installer)
wget --recursive --no-host-directories -e robots=off --cut-dirs=5 --no-parent --reject "index.html*" https://dist.apache.org/repos/dist/dev/incubator/streampipes/

Step 2: Validate

...

streampipes

First, open the folder ({version}/{rc}) (e.g., 0.6970.0/rc1).

Check signatures and checksums

...

Code Block
languagebash
titleVerify signature
gpg --verify apache-streampipes-{current-full-version}-incubating-source-release.zip.asc apache-streampipes-{current-full-version}-incubating-source-release.zip

# example
gpg --verify apache-streampipes-0.6992.0-incubating-source-release.zip.asc apache-streampipes-0.6992.0-incubating-source-release.zip


Verify the checksum

Code Block
titleVerify checksum
sha512sum -c apache-streampipes-{current-full-version}-incubating-source-release.zip.sha512

# example:
sha512sum -c apache-streampipes-0.6892.0-incubating-source-release.zip.sha512

# alternative (if you get an error such as no properly formatted SHA512 checksum lines found)
# print the checksum
cat apache-streampipes-0.6892.0-incubating-source-release.zip.sha512
# print the checksum of the zip file
sha512sum apache-streampipes-0.6892.0-incubating-source-release.zip
# compare both checksums

...

Code Block
titleUnzip
unzip apache-streampipes-{current-full-version}-incubating-source-release.zip
cd apache-streampipes-{current-full-version}-incubating/

# example:
unzip apache-streampipes-0.6892.0-incubating-source-release.zip

cd apache-streampipes-0.6892.0-incubating/


Verify legal information and required files

...

Code Block
titleBuild UI
# cd ui

npm install
# If this results in an error, do npm install --legacy-peer-deps

npm run build

Start test system 

...

Code Block
titleSet proper line encoding in docker entrypoint
# in most cases, this step is optional - seems to only occur in rare cases on Windows systems

# Set the correct EOL encoding for the UI entrypoint file (docker-entrypoint.sh) file to LF:
awk 'BEGIN{RS="^$";ORS="";getline;gsub("\r","");print>ARGV[1]}' ui/docker-entrypoint.sh

# Alternative: Open the file ui/docker-entrypoint.sh, change the eol encoding to "LF" (e.g., in Notepad++ by clicking on "Windows CRLF" in the bottom status bar).

...

Code Block
titleBuild Docker images and start
# from root directory

docker-compose up --build -d

# Use docker-compose up to run it in foreground
# Docker images will be locally built

...