Skip to content

chore(release): v1.0.0-rc.1 (#238) #27

chore(release): v1.0.0-rc.1 (#238)

chore(release): v1.0.0-rc.1 (#238) #27

Workflow file for this run

# The way this works is the following:
#
# The create-release job runs purely to initialize the GitHub release itself
# and to output upload_url for the following job.
#
# The build-release job runs only once create-release is finished. It gets the
# release upload URL from create-release job outputs, then builds the release
# executables for each supported platform and attaches them as release assets
# to the previously created release.
#
# The key here is that we create the release only once.
#
# Reference:
# https://eugene-babichenko.github.io/blog/2020/05/09/github-actions-cross-platform-auto-releases/
# https://github.com/crate-ci/cargo-release/blob/91549dbf9db9915ba5f121890ad0816c7d851679/.github/workflows/post-release.yml
name: release
on:
push:
tags:
- "v*"
env:
LIB_NAME: libiroh_ffi
PACKAGE_NAME: libiroh
IROH_FORCE_STAGING_RELAYS: "1"
jobs:
create-release:
name: create-release
runs-on: ubuntu-latest
outputs:
upload_url: ${{ steps.release.outputs.upload_url }}
release_version: ${{ env.RELEASE_VERSION }}
steps:
- name: Get the release version from the tag
shell: bash
if: env.RELEASE_VERSION == ''
run: |
# See: https://github.community/t5/GitHub-Actions/How-to-get-just-the-tag-name/m-p/32167/highlight/true#M1027
echo "RELEASE_VERSION=${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
echo "version is: ${{ env.RELEASE_VERSION }}"
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Create GitHub release
id: release
uses: actions/create-release@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag_name: ${{ env.RELEASE_VERSION }}
release_name: ${{ env.RELEASE_VERSION }}
build-and-publish-libs:
name: Build & publish release libraries
needs: create-release
runs-on: ${{ matrix.runner }}
strategy:
matrix:
name: [ubuntu-latest, ubuntu-arm-latest, macOS-arm-latest, windows-latest]
rust: [stable]
include:
- name: ubuntu-arm-latest
os: ubuntu-latest
cargo_target: "aarch64-unknown-linux-musl"
target: linux-aarch64
runner: [self-hosted, linux, ARM64]
- name: ubuntu-latest
os: ubuntu-latest
cargo_target: "x86_64-unknown-linux-musl"
target: linux-x86_64
runner: [self-hosted, linux, X64]
- name: macOS-arm-latest
os: macOS-latest
cargo_target: "aarch64-apple-darwin"
target: darwin-aarch64
runner: [self-hosted, macOS, ARM64]
# TODO: windows runner is not available on the org level
- name: windows-latest
os: windows-latest
cargo_target: "x86_64-pc-windows-msvc"
target: windows-x86_64
runner: [windows-latest]
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Install Rust
uses: dtolnay/rust-toolchain@stable
with:
toolchain: ${{ matrix.rust }}
targets: ${{matrix.cargo_target}}
- name: Ensure musl support
if: ${{ contains(matrix.cargo_target, '-musl') }}
run: sudo apt-get install musl-tools -y
- name: Build release binary
shell: bash
run: |
if [ "${{ matrix.name }}" = "ubuntu-arm-latest" ]; then
export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER=aarch64-linux-gnu-gcc
export CC=aarch64-linux-gnu-gcc
fi
cargo build --verbose --release --target ${{matrix.cargo_target}}
- name: Build archive
shell: bash
run: |
outdir="./target/${{matrix.cargo_target}}/release"
staging="${{ env.PACKAGE_NAME }}-${{ matrix.target }}"
mkdir -p "$staging"
if [ "${{ matrix.os }}" = "windows-latest" ]; then
cp "target/${{matrix.cargo_target}}/release/iroh_ffi.lib" "$staging/iroh.lib"
cd "$staging"
7z a "../$staging.zip" .
echo "ASSET=$staging.zip" >> $GITHUB_ENV
else
cp "target/${{matrix.cargo_target}}/release/${{ env.LIB_NAME }}.a" "$staging/${{ env.PACKAGE_NAME }}.a"
tar czf "$staging.tar.gz" -C "$staging" .
echo "ASSET=$staging.tar.gz" >> $GITHUB_ENV
fi
- name: Upload release archive
uses: actions/upload-release-asset@v1.0.2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ needs.create-release.outputs.upload_url }}
asset_path: ${{ env.ASSET }}
asset_name: ${{ env.ASSET }}
asset_content_type: application/octet-stream
build-and-publish-swift:
name: Build & publish swift libraries
timeout-minutes: 30
runs-on: [self-hosted, macOS, ARM64]
needs: create-release
steps:
- uses: actions/checkout@master
- uses: dtolnay/rust-toolchain@stable
with:
targets: aarch64-apple-ios,aarch64-apple-ios-sim,x86_64-apple-ios,aarch64-apple-darwin
- uses: davidB/rust-cargo-make@v1
- name: Make swift
# Same deterministic zip recipe as local `cargo make prepare-release`,
# so the SHA-256 baked into Package.swift in the release PR matches
# the asset uploaded here.
run: |
cargo make swift-xcframework
bash scripts/release/zip_xcframework.sh
- name: Upload release archive
uses: actions/upload-release-asset@v1.0.2
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ needs.create-release.outputs.upload_url }}
asset_path: IrohLib.xcframework.zip
asset_name: IrohLib.xcframework.zip
asset_content_type: application/octet-stream
# Cross-build the desktop cdylibs for each JVM host the Maven artifact
# should support. JNI libs are loaded by JNA from classpath at
# `<jna-platform>/libname.{so,dylib,dll}`; see the staging step below.
# Android ABIs are not packaged in this JVM-only artifact yet — that
# needs a separate com.android.library AAR publication.
build-kotlin-cdylib:
name: Build Kotlin cdylib (${{ matrix.name }})
needs: create-release
timeout-minutes: 60
runs-on: ${{ matrix.runner }}
strategy:
fail-fast: false
matrix:
include:
- name: linux-x86_64
runner: [self-hosted, linux, X64]
target: x86_64-unknown-linux-gnu
lib_file: libiroh_ffi.so
- name: linux-aarch64
runner: [self-hosted, linux, ARM64]
target: aarch64-unknown-linux-gnu
lib_file: libiroh_ffi.so
- name: macos-aarch64
runner: [self-hosted, macOS, ARM64]
target: aarch64-apple-darwin
lib_file: libiroh_ffi.dylib
- name: windows-x86_64
runner: [windows-latest]
target: x86_64-pc-windows-msvc
lib_file: iroh_ffi.dll
steps:
- uses: actions/checkout@master
- uses: dtolnay/rust-toolchain@stable
with:
targets: ${{ matrix.target }}
- uses: Swatinem/rust-cache@v2
- run: cargo build --release --lib -p iroh-ffi --target ${{ matrix.target }}
- uses: actions/upload-artifact@v4
with:
name: kotlin-cdylib-${{ matrix.name }}
path: target/${{ matrix.target }}/release/${{ matrix.lib_file }}
if-no-files-found: error
build-and-publish-kotlin:
name: Publish Kotlin to Maven Central
timeout-minutes: 30
needs: [create-release, build-kotlin-cdylib]
runs-on: [self-hosted, linux, X64]
steps:
- uses: actions/checkout@master
- uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- uses: davidB/rust-cargo-make@v1
- uses: actions/setup-java@v4
with:
distribution: temurin
java-version: "17"
# Generate `iroh_ffi.kt` from the local debug cdylib. We discard the
# flat resources/libiroh_ffi.so it also copies, because we're shipping
# the per-platform release builds under jna-platform/ dirs instead.
- name: Generate Kotlin bindings
run: cargo make bindgen-kotlin
- uses: actions/download-artifact@v4
with:
pattern: kotlin-cdylib-*
path: cdylibs/
- name: Stage cdylibs under jna-platform dirs
shell: bash
run: |
set -eu
RES=kotlin/lib/src/main/resources
rm -f "$RES"/libiroh_ffi.so "$RES"/libiroh_ffi.dylib "$RES"/iroh_ffi.dll
install -D -m644 cdylibs/kotlin-cdylib-linux-x86_64/libiroh_ffi.so "$RES/linux-x86-64/libiroh_ffi.so"
install -D -m644 cdylibs/kotlin-cdylib-linux-aarch64/libiroh_ffi.so "$RES/linux-aarch64/libiroh_ffi.so"
install -D -m644 cdylibs/kotlin-cdylib-macos-aarch64/libiroh_ffi.dylib "$RES/darwin-aarch64/libiroh_ffi.dylib"
install -D -m644 cdylibs/kotlin-cdylib-windows-x86_64/iroh_ffi.dll "$RES/win32-x86-64/iroh_ffi.dll"
find "$RES" -type f
- name: Publish to Maven Central
working-directory: kotlin
env:
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.SONATYPE_USERNAME }}
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_PASSWORD }}
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
run: ./gradlew :lib:publishAndReleaseToMavenCentral --no-daemon --console=plain