Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add release automation workflow for binary distribution #60

Merged
merged 9 commits into from
Feb 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 142 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
name: Release

on:
push:
branches:
- main
tags: ['v*']

jobs:
build:
runs-on: ubuntu-22.04
strategy:
fail-fast: true
matrix:
target:
- x86_64-unknown-linux-musl

steps:
- uses: actions/[email protected]

- name: install apt depenedencies
run: |
sudo apt-get update
sudo apt-get install -y musl-tools

- name: Get Rust toolchain
id: toolchain
working-directory: .
run: |
awk -F'[ ="]+' '$1 == "channel" { print "toolchain=" $2 }' rust-toolchain >> "$GITHUB_OUTPUT"

- uses: dtolnay/rust-toolchain@v1
with:
toolchain: ${{ steps.toolchain.outputs.toolchain }}
targets: ${{ matrix.target }}

- uses: Swatinem/[email protected]

- name: install cargo-about
run: |
cargo install --locked cargo-about

- name: Build
run: |
cargo build --target=${{ matrix.target }} --release --locked

- name: Rename binaries
run: |
mkdir bin
kble_bins=("kble" "kble-c2a" "kble-eb90" "kble-serialport")
for b in "${kble_bins[@]}" ; do
cp "./target/${{ matrix.target }}/release/${b}" "./bin/${b}-${{ matrix.target }}"
done
ls -lh ./bin

- uses: actions/[email protected]
with:
name: release-executable-${{ matrix.target }}
if-no-files-found: error
path: ./bin/

build_kble_serialport_win:
name: build / kble-serialport.exe
# C2A Boom ecosystem does **NOT** support native Windows environment.
# However, WSL2 environment is supported and has many use cases in the real world.
# Here, there are difficulties in running kble-serialport inside WSL2,
# a component that interfaces with external hardware (USB-RS devices).
# Although it is possible to show a Windows host USB devices
# to a WSL2 Linux VM using the usbipd-win project, this is still a bit unstable.
# Also, kble-serialport is a very small component that does not need to be updated frequently for practical use.
# For these reasons, we currently choose to run only kble-serialport on Windows host.

runs-on: windows-2022

env:
TARGET: x86_64-pc-windows-msvc

steps:
- uses: actions/[email protected]

- name: Get Rust toolchain
id: toolchain
working-directory: .
shell: bash
run: |
awk -F'[ ="]+' '$1 == "channel" { print "toolchain=" $2 }' rust-toolchain >> "$GITHUB_OUTPUT"

- uses: dtolnay/rust-toolchain@v1
with:
toolchain: ${{ steps.toolchain.outputs.toolchain }}
targets: ${{ env.TARGET }}

- uses: Swatinem/[email protected]

- name: install cargo-about
run: |
cargo install --locked cargo-about

- name: Build
run: |
cargo build --target=${{ env.TARGET }} -p kble-serialport --release --locked

- name: Rename binary
shell: bash
run: |
mkdir bin
cp "./target/${{ env.TARGET }}/release/kble-serialport.exe" "./bin/kble-serialport-${{ env.TARGET }}.exe"
ls -lh ./bin

- uses: actions/[email protected]
with:
name: release-executable-${{ env.TARGET }}
if-no-files-found: error
path: ./bin/

release:
name: Release
needs: [ build, build_kble_serialport_win ]
permissions:
contents: write

runs-on: ubuntu-22.04

steps:
- uses: actions/[email protected]
with:
pattern: release-executable-*
merge-multiple: true

- run: chmod +x kble-*

- run: ls -lh

- name: Release to GitHub Release
if: startsWith(github.ref, 'refs/tags/')
uses: softprops/[email protected]
with:
draft: true
fail_on_unmatched_files: true
generate_release_notes: true
files: |
kble*
29 changes: 22 additions & 7 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[workspace.package]
version = "0.2.0"
version = "0.3.0-beta.1"
repository = "https://github.com/arkedge/kble"
license = "MIT"
edition = "2021"
Expand Down