Skip to content

v0.10.0-rc

v0.10.0-rc #576

Workflow file for this run

#
# Copyright (c) 2023 ZettaScale Technology
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
# which is available at https://www.apache.org/licenses/LICENSE-2.0.
#
# SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
#
# Contributors:
# ZettaScale Zenoh Team, <[email protected]>
#
name: Release
on:
release:
types: [published]
schedule:
- cron: "0 0 * * 1-5"
workflow_dispatch:
inputs:
runtests:
description: "run tests"
type: boolean
doc:
description: "generate doc"
type: boolean
publish:
description: "publish"
type: boolean
githubrelease:
description: "publish as github release"
type: boolean
eclipse:
description: "publish to download.eclipse.org/zenoh"
type: boolean
cratesio:
description: "publish to crates.io"
type: boolean
dockerhub:
description: "publish to dockerhub"
type: boolean
features:
description: "build with specified features (comma separated, no space)"
type: string
jobs:
checks:
name: Code checks
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install Rust toolchain
run: |
rustup show
rustup component add rustfmt clippy
- name: Code format check
uses: actions-rs/cargo@v1
with:
command: fmt
args: -- --check
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
- name: Clippy check
uses: actions-rs/cargo@v1
with:
command: clippy
args: --all-targets --features=${{ github.event.inputs.features}} -- -D warnings
- name: Clippy unstable check
uses: actions-rs/cargo@v1
with:
command: clippy
args: --all-targets --features unstable -- -D warnings
- name: Clippy shared-memory
uses: actions-rs/cargo@v1
with:
command: clippy
args: --all-targets --features shared-memory -- -D warnings
- name: Environment setup
id: env
shell: bash
run: |
# log some info
gcc --version || true
rustup -V
rustup toolchain list
rustup default
cargo -V
rustc -V
echo "GITHUB_REF=${GITHUB_REF}"
echo "GITHUB_SHA=${GITHUB_SHA:0:8}"
GIT_BRANCH=`[[ $GITHUB_REF =~ ^refs/heads/.* ]] && echo ${GITHUB_REF/refs\/heads\//} || true`
echo "GIT_BRANCH=${GIT_BRANCH}" >> $GITHUB_OUTPUT
GIT_TAG=`[[ $GITHUB_REF =~ ^refs/tags/.* ]] && echo ${GITHUB_REF/refs\/tags\//} || true`
echo "GIT_TAG=${GIT_TAG}" >> $GITHUB_OUTPUT
sudo apt-get update
sudo apt-get install -y jq
ZENOH_VERSION=$(cargo metadata --no-deps --format-version 1 | jq -r '.packages[] | select(.name == "zenoh") | .version')
echo "ZENOH_VERSION=${ZENOH_VERSION}" >> $GITHUB_OUTPUT
if [ -n "${GIT_TAG}" ]; then
IS_RELEASE="true"
echo "IS_RELEASE=${IS_RELEASE}" >> $GITHUB_OUTPUT
PKG_VERSION=${ZENOH_VERSION}
elif [ -n "${GIT_BRANCH}" ]; then
PKG_VERSION=${GIT_BRANCH}-${GITHUB_SHA:0:8}
else
PKG_VERSION=${ZENOH_VERSION}-${GITHUB_SHA:0:8}
fi
echo "PKG_VERSION=${PKG_VERSION}" >> $GITHUB_OUTPUT
echo "GITHUB_OUTPUT : ${GITHUB_OUTPUT}"
outputs:
GIT_BRANCH: ${{ steps.env.outputs.GIT_BRANCH }}
GIT_TAG: ${{ steps.env.outputs.GIT_TAG }}
IS_RELEASE: ${{ steps.env.outputs.IS_RELEASE }}
ZENOH_VERSION: ${{ steps.env.outputs.ZENOH_VERSION }}
PKG_VERSION: ${{ steps.env.outputs.PKG_VERSION }}
tests:
name: Tests
if: ${{ !(github.event.inputs.runtests == 'false') }}
needs: checks
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install Rust toolchain
run: rustup show
- name: Install nextest
run: cargo install cargo-nextest --locked
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
- name: Run tests
uses: actions-rs/cargo@v1
with:
command: nextest
args: run --release --features=${{ github.event.inputs.features}} --verbose
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
ASYNC_STD_THREAD_COUNT: 4
- name: Run doctests
uses: actions-rs/cargo@v1
with:
command: test
args: --release --features=${{ github.event.inputs.features}} --doc
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
ASYNC_STD_THREAD_COUNT: 4
doc:
name: Doc generation
if: ${{ !(github.event.inputs.doc == 'false') }}
needs: checks
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# Use a similar command than docs.rs build: rustdoc with nightly toolchain
- name: Install Rust toolchain nightly for docs gen
run: rustup toolchain install nightly
- name: generate doc
uses: actions-rs/cargo@v1
env:
RUSTDOCFLAGS: -Dwarnings
with:
toolchain: nightly
command: rustdoc
# NOTE: force 'unstable' feature for doc generation, as forced for docs.rs build in zenoh/Cargo.toml
args: --manifest-path ./zenoh/Cargo.toml --lib -Zrustdoc-map --features unstable -Z unstable-options --config build.rustdocflags='["-Z", "unstable-options", "--emit=invocation-specific", "--cap-lints", "warn", "--disable-per-crate-search", "--extern-html-root-takes-precedence"]' -Zunstable-options -Zrustdoc-scrape-examples -j3
builds:
name: Build for ${{ matrix.job.target }} on ${{ matrix.job.os }}
needs: checks
runs-on: ${{ matrix.job.os }}
strategy:
fail-fast: false
matrix:
job:
- { target: x86_64-unknown-linux-gnu, arch: amd64, os: ubuntu-20.04 }
- {
target: x86_64-unknown-linux-musl,
arch: amd64,
os: ubuntu-20.04,
use-cross: true,
}
- {
target: arm-unknown-linux-gnueabi,
arch: armel,
os: ubuntu-20.04,
use-cross: true,
}
- {
target: arm-unknown-linux-gnueabihf,
arch: armhf,
os: ubuntu-20.04,
use-cross: true,
}
- {
target: armv7-unknown-linux-gnueabihf,
arch: armhf,
os: ubuntu-20.04,
use-cross: true,
}
- {
target: aarch64-unknown-linux-gnu,
arch: arm64,
os: ubuntu-20.04,
use-cross: true,
}
- {
target: aarch64-unknown-linux-musl,
arch: arm64,
os: ubuntu-20.04,
use-cross: true,
}
- { target: x86_64-apple-darwin, arch: darwin, os: macos-latest }
- { target: aarch64-apple-darwin, arch: darwin, os: macos-latest }
- { target: x86_64-pc-windows-msvc, arch: win64, os: windows-2019 }
# - { target: x86_64-pc-windows-gnu , arch: win64 , os: windows-2019 }
steps:
- name: Checkout source code
uses: actions/checkout@v2
with:
fetch-depth: 500 # NOTE: get long history for git-version crate to correctly compute a version
- name: Fetch Git tags # NOTE: workaround for https://github.com/actions/checkout/issues/290
shell: bash
run: git fetch --tags --force
- name: Install prerequisites
shell: bash
run: |
case ${{ matrix.job.target }} in
*-linux-gnu*) cargo install cargo-deb ;;
esac
case ${{ matrix.job.target }} in
arm-unknown-linux-gnueabi)
sudo apt-get -y update
sudo apt-get -y install gcc-arm-linux-gnueabi
;;
arm*-unknown-linux-gnueabihf)
sudo apt-get -y update
sudo apt-get -y install gcc-arm-linux-gnueabihf
;;
aarch64-unknown-linux-gnu)
sudo apt-get -y update
sudo apt-get -y install gcc-aarch64-linux-gnu
;;
esac
- name: Install Rust toolchain
run: |
rustup show
rustup target add ${{ matrix.job.target }}
- name: Build
uses: actions-rs/cargo@v1
with:
use-cross: ${{ matrix.job.use-cross }}
command: build
args: --release --bins --lib --features=${{ github.event.inputs.features}} --target=${{ matrix.job.target }}
- name: Debian package - zenohd
if: contains(matrix.job.target, '-linux-gnu')
uses: actions-rs/cargo@v1
with:
command: deb
args: --no-build --target=${{ matrix.job.target }} -p zenohd
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
- name: Debian package - zenoh-plugin-storage-manager
if: contains(matrix.job.target, '-linux-gnu')
uses: actions-rs/cargo@v1
with:
command: deb
args: --no-build --target=${{ matrix.job.target }} -p zenoh-plugin-storage-manager
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
- name: Debian package - zenoh-plugin-rest
if: contains(matrix.job.target, '-linux-gnu')
uses: actions-rs/cargo@v1
with:
command: deb
args: --no-build --target=${{ matrix.job.target }} -p zenoh-plugin-rest
env:
CARGO_REGISTRIES_CRATES_IO_PROTOCOL: sparse
- name: Packaging
id: package
shell: bash
run: |
TARGET=${{ matrix.job.target }}
MAIN_PKG_NAME="${GITHUB_WORKSPACE}/zenoh-${{ needs.checks.outputs.PKG_VERSION }}-${TARGET}.zip"
DEBS_PKG_NAME="${GITHUB_WORKSPACE}/zenoh-${{ needs.checks.outputs.PKG_VERSION }}-${TARGET}-deb-pkgs.zip"
case ${TARGET} in
*linux*)
cd "target/${TARGET}/release/"
echo "Packaging ${MAIN_PKG_NAME}:"
zip ${MAIN_PKG_NAME} zenohd libzenoh_plugin_*.so
cd -
echo "MAIN_PKG_NAME=${MAIN_PKG_NAME}" >> $GITHUB_OUTPUT
# check if debian packages has been created and packages them in a single tgz
if [[ -d target/${TARGET}/debian ]]; then
cd target/${TARGET}/debian
${GITHUB_WORKSPACE}/gen_zenoh_deb.sh ${{ needs.checks.outputs.ZENOH_VERSION }} ${{ matrix.job.arch }}
echo "Packaging ${DEBS_PKG_NAME}:"
zip ${DEBS_PKG_NAME} *.deb
cd -
echo "DEBS_PKG_NAME=${DEBS_PKG_NAME}" >> $GITHUB_OUTPUT
fi
;;
*apple*)
cd "target/${TARGET}/release/"
echo "Packaging ${MAIN_PKG_NAME}:"
zip ${MAIN_PKG_NAME} zenohd libzenoh_plugin_*.dylib
cd -
echo "MAIN_PKG_NAME=${MAIN_PKG_NAME}" >> $GITHUB_OUTPUT
;;
*windows*)
cd "target/${TARGET}/release/"
echo "Packaging ${MAIN_PKG_NAME}:"
7z -y a "${MAIN_PKG_NAME}" zenohd.exe zenoh_plugin_*.dll
cd -
echo "MAIN_PKG_NAME=${MAIN_PKG_NAME}" >> $GITHUB_OUTPUT
;;
esac
- name: "Upload packages"
uses: actions/upload-artifact@master
with:
name: ${{ matrix.job.target }}
path: |
${{ steps.package.outputs.MAIN_PKG_NAME }}
${{ steps.package.outputs.DEBS_PKG_NAME }}
publication:
name: Release publication
if: ${{ (needs.checks.outputs.IS_RELEASE == 'true' || github.event.inputs.publish == 'true') && !failure() }}
needs: [checks, builds, tests, doc]
runs-on: ubuntu-latest
steps:
- name: Download result of previous builds
uses: actions/download-artifact@v2
with:
path: ARTIFACTS
- name: Publish as github release
if: ${{ !(github.event.inputs.githubrelease == 'false') }}
uses: softprops/action-gh-release@v1
with:
files: ARTIFACTS/*/*.*
- name: Publish to download.eclipse.org/zenoh
if: ${{ !(github.event.inputs.eclipse == 'false') }}
env:
SSH_TARGET: [email protected]
ECLIPSE_BASE_DIR: /home/data/httpd/download.eclipse.org/zenoh
shell: bash
run: |
echo "--- setup ssh-agent"
eval "$(ssh-agent -s)"
echo 'echo "${{ secrets.SSH_PASSPHRASE }}"' > ~/.ssh_askpass && chmod +x ~/.ssh_askpass
echo "${{ secrets.SSH_PRIVATE_KEY }}" | tr -d '\r' | DISPLAY=NONE SSH_ASKPASS=~/.ssh_askpass ssh-add - > /dev/null 2>&1
rm -f ~/.ssh_askpass
echo "--- test ssh:"
ssh -o "StrictHostKeyChecking=no" ${SSH_TARGET} ls -al
echo "---- list artifacts to upload:"
ls -R ARTIFACTS || true
DOWNLOAD_DIR=${ECLIPSE_BASE_DIR}/zenoh/${{ needs.checks.outputs.ZENOH_VERSION }}
echo "---- copy artifacts into ${DOWNLOAD_DIR}"
ssh -o "StrictHostKeyChecking=no" ${SSH_TARGET} mkdir -p ${DOWNLOAD_DIR}
cd ARTIFACTS
sha256sum */* > sha256sums.txt
scp -o "StrictHostKeyChecking=no" -r * ${SSH_TARGET}:${DOWNLOAD_DIR}/
echo "---- cleanup identity"
ssh-add -D
- uses: actions/checkout@v2
- name: Install Rust toolchain
if: ${{ !(github.event.inputs.cratesio == 'false') }}
run: rustup show
- name: Check crates
if: ${{ !(github.event.inputs.cratesio == 'false') }}
shell: bash
run: .github/workflows/crates_check.sh
- name: Publish to crates.io
if: ${{ !(github.event.inputs.cratesio == 'false') }}
shell: bash
run: |
set +x
.github/workflows/crates_publish.sh ${{ secrets.CRATES_IO_TOKEN }}
- name: Cancel workflow if fail # thus Docker job be interrupted
if: failure()
uses: andymckay/[email protected]
docker:
name: Docker build and push
if: ${{ !(github.event.inputs.dockerhub == 'false') && !failure() }}
needs: [checks, builds, tests, doc]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 500 # NOTE: get long history for git-version crate to correctly compute a version
- name: Fetch Git tags # NOTE: workaround for https://github.com/actions/checkout/issues/290
shell: bash
run: git fetch --tags --force
- name: Download packages from previous job
uses: actions/download-artifact@v2
with:
path: PACKAGES
- name: Unzip PACKAGES
run: |
ls PACKAGES
mkdir -p docker/linux/amd
unzip PACKAGES/x86_64-unknown-linux-musl/zenoh-${{ needs.checks.outputs.PKG_VERSION }}-x86_64-unknown-linux-musl.zip -d docker/linux/amd64/
rm docker/linux/amd64/libzenoh_plugin_example.so
mkdir -p docker/linux/arm64
unzip PACKAGES/aarch64-unknown-linux-musl/zenoh-${{ needs.checks.outputs.PKG_VERSION }}-aarch64-unknown-linux-musl.zip -d docker/linux/arm64/
rm docker/linux/arm64/libzenoh_plugin_example.so
tree docker
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Docker meta - set tags and labels
id: meta
uses: docker/metadata-action@v3
with:
images: eclipse/zenoh
labels: |
org.opencontainers.image.licenses=EPL-2.0 OR Apache-2.0
- name: Login to DockerHub
uses: docker/login-action@v1
with:
username: ${{ secrets.DOCKER_COM_USERNAME }}
password: ${{ secrets.DOCKER_COM_PASSWORD }}
- name: Build and push
uses: docker/build-push-action@v2
with:
context: .
push: true
platforms: linux/amd64, linux/arm64
file: .github/workflows/Dockerfile
tags: ${{ steps.meta.outputs.tags }}
labels: ${{ steps.meta.outputs.labels }}