Release #56
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# 2024-08-10 07:10 | |
# rust-toolchain@master (dtolnay version) | |
name: Release | |
env: | |
CICD_INTERMEDIATES_DIR: "_cicd-intermediates" | |
MSRV_FEATURES: "--all-features" | |
TAG_PREFIX: "v" | |
TAG_SUFFIX: "-release" | |
on: | |
workflow_dispatch: | |
# pull_request: | |
# push: | |
# branches: | |
# - master | |
# tags: | |
# - '*' | |
jobs: | |
crate_metadata: | |
name: Extract crate metadata | |
runs-on: ubuntu-latest | |
steps: | |
- uses: deep-soft/checkout@v4 | |
- name: Extract crate information | |
id: crate_metadata | |
run: | | |
echo "name=fd" | tee -a $GITHUB_OUTPUT | |
cargo metadata --no-deps --format-version 1 | jq -r '"version=" + .packages[0].version' | tee -a $GITHUB_OUTPUT | |
cargo metadata --no-deps --format-version 1 | jq -r '"maintainer=" + .packages[0].authors[0]' | tee -a $GITHUB_OUTPUT | |
cargo metadata --no-deps --format-version 1 | jq -r '"homepage=" + .packages[0].homepage' | tee -a $GITHUB_OUTPUT | |
cargo metadata --no-deps --format-version 1 | jq -r '"msrv=" + .packages[0].rust_version' | tee -a $GITHUB_OUTPUT | |
outputs: | |
name: ${{ steps.crate_metadata.outputs.name }} | |
version: ${{ steps.crate_metadata.outputs.version }} | |
maintainer: ${{ steps.crate_metadata.outputs.maintainer }} | |
homepage: ${{ steps.crate_metadata.outputs.homepage }} | |
msrv: ${{ steps.crate_metadata.outputs.msrv }} | |
ensure_cargo_fmt: | |
name: Ensure 'cargo fmt' has been run | |
runs-on: ubuntu-20.04 | |
steps: | |
- uses: deep-soft/rust-toolchain@master | |
# uses: deep-soft/rust-toolchain-actions-rs@v3 | |
# uses: dtolnay/rust-toolchain@stable | |
with: | |
toolchain: stable | |
components: rustfmt | |
- uses: deep-soft/checkout@v4 | |
- run: cargo fmt -- --check | |
min_version: | |
name: Minimum supported rust version | |
runs-on: ubuntu-20.04 | |
needs: crate_metadata | |
steps: | |
- name: Checkout source code | |
uses: deep-soft/checkout@v4 | |
- name: Install rust toolchain (v${{ needs.crate_metadata.outputs.msrv }}) | |
uses: deep-soft/rust-toolchain@master | |
# deep-soft/rust-toolchain-actions-rs@v3 | |
# uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: ${{ needs.crate_metadata.outputs.msrv }} | |
components: clippy | |
- name: Run clippy (on minimum supported rust version to prevent warnings we can't fix) | |
run: cargo clippy --locked --all-targets ${{ env.MSRV_FEATURES }} | |
- name: Run tests | |
run: cargo test --locked ${{ env.MSRV_FEATURES }} | |
build: | |
name: ${{ matrix.job.target }} (${{ matrix.job.os }}) | |
runs-on: ${{ matrix.job.os }} | |
needs: crate_metadata | |
strategy: | |
fail-fast: false | |
matrix: | |
job: | |
- { target: aarch64-unknown-linux-gnu , os: ubuntu-20.04, use-cross: true } | |
- { target: aarch64-unknown-linux-musl , os: ubuntu-20.04, use-cross: true } | |
- { target: arm-unknown-linux-gnueabihf , os: ubuntu-20.04, use-cross: true } | |
- { target: arm-unknown-linux-musleabihf, os: ubuntu-20.04, use-cross: true } | |
- { target: i686-pc-windows-msvc , os: windows-2019 } | |
- { target: i686-unknown-linux-gnu , os: ubuntu-20.04, use-cross: true } | |
- { target: i686-unknown-linux-musl , os: ubuntu-20.04, use-cross: true } | |
- { target: x86_64-apple-darwin , os: macos-12 } | |
- { target: x86_64-pc-windows-gnu , os: windows-2019 } | |
- { target: x86_64-pc-windows-msvc , os: windows-2019 } | |
- { target: x86_64-unknown-linux-gnu , os: ubuntu-20.04, use-cross: true } | |
- { target: x86_64-unknown-linux-musl , os: ubuntu-20.04, use-cross: true } | |
env: | |
BUILD_CMD: cargo | |
steps: | |
- name: Checkout source code | |
uses: deep-soft/checkout@v4 | |
- name: Install prerequisites | |
shell: bash | |
run: | | |
case ${{ matrix.job.target }} in | |
arm-unknown-linux-*) 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: Extract crate information | |
shell: bash | |
run: | | |
echo "PROJECT_NAME=fd" >> $GITHUB_ENV | |
echo "PROJECT_VERSION=$(sed -n 's/^version = "\(.*\)"/\1/p' Cargo.toml | head -n1)" >> $GITHUB_ENV | |
echo "PROJECT_MAINTAINER=$(sed -n 's/^authors = \["\(.*\)"\]/\1/p' Cargo.toml)" >> $GITHUB_ENV | |
echo "PROJECT_HOMEPAGE=$(sed -n 's/^homepage = "\(.*\)"/\1/p' Cargo.toml)" >> $GITHUB_ENV | |
- name: Install Rust toolchain | |
uses: deep-soft/rust-toolchain@master | |
# uses: deep-soft/rust-toolchain-actions-rs@v3 | |
# uses: dtolnay/rust-toolchain@stable | |
with: | |
toolchain: stable | |
target: ${{ matrix.job.target }} | |
- name: Install cross | |
if: matrix.job.use-cross | |
# uses: taiki-e/install-action@v2 | |
uses: deep-soft/install-action@v2 | |
with: | |
tool: cross | |
- name: Overwrite build command env variable | |
if: matrix.job.use-cross | |
shell: bash | |
run: echo "BUILD_CMD=cross" >> $GITHUB_ENV | |
- name: Show version information (Rust, cargo, GCC) | |
shell: bash | |
run: | | |
gcc --version || true | |
rustup -V | |
rustup toolchain list | |
rustup default | |
cargo -V | |
rustc -V | |
- name: Build | |
shell: bash | |
run: $BUILD_CMD build --locked --release --target=${{ matrix.job.target }} | |
- name: Set binary name & path | |
id: bin | |
shell: bash | |
run: | | |
# Figure out suffix of binary | |
EXE_suffix="" | |
case ${{ matrix.job.target }} in | |
*-pc-windows-*) EXE_suffix=".exe" ;; | |
esac; | |
# Setup paths | |
BIN_NAME="${{ needs.crate_metadata.outputs.name }}${EXE_suffix}" | |
BIN_PATH="target/${{ matrix.job.target }}/release/${BIN_NAME}" | |
# Let subsequent steps know where to find the binary | |
echo "BIN_PATH=${BIN_PATH}" >> $GITHUB_OUTPUT | |
echo "BIN_NAME=${BIN_NAME}" >> $GITHUB_OUTPUT | |
- name: Set testing options | |
id: test-options | |
shell: bash | |
run: | | |
# test only library unit tests and binary for arm-type targets | |
unset CARGO_TEST_OPTIONS | |
unset CARGO_TEST_OPTIONS ; case ${{ matrix.job.target }} in arm-* | aarch64-*) CARGO_TEST_OPTIONS="--bin ${{ needs.crate_metadata.outputs.name }}" ;; esac; | |
echo "CARGO_TEST_OPTIONS=${CARGO_TEST_OPTIONS}" >> $GITHUB_OUTPUT | |
- name: Run tests | |
shell: bash | |
run: $BUILD_CMD test --locked --target=${{ matrix.job.target }} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}} | |
- name: Generate completions | |
id: completions | |
shell: bash | |
run: make completions | |
- name: Create tarball | |
id: package | |
shell: bash | |
run: | | |
PKG_suffix=".tar.gz" ; case ${{ matrix.job.target }} in *-pc-windows-*) PKG_suffix=".zip" ;; esac; | |
PKG_BASENAME=${{ needs.crate_metadata.outputs.name }}-v${{ needs.crate_metadata.outputs.version }}-${{ matrix.job.target }} | |
PKG_NAME=${PKG_BASENAME}${PKG_suffix} | |
echo "PKG_NAME=${PKG_NAME}" >> $GITHUB_OUTPUT | |
PKG_STAGING="${{ env.CICD_INTERMEDIATES_DIR }}/package" | |
ARCHIVE_DIR="${PKG_STAGING}/${PKG_BASENAME}/" | |
mkdir -p "${ARCHIVE_DIR}" | |
# Binary | |
cp "${{ steps.bin.outputs.BIN_PATH }}" "$ARCHIVE_DIR" | |
# README, LICENSE and CHANGELOG files | |
cp "README.md" "LICENSE-MIT" "LICENSE-APACHE" "CHANGELOG.md" "$ARCHIVE_DIR" | |
# Man page | |
cp 'doc/${{ needs.crate_metadata.outputs.name }}.1' "$ARCHIVE_DIR" | |
# Autocompletion files | |
cp -r autocomplete "${ARCHIVE_DIR}" | |
# base compressed package | |
pushd "${PKG_STAGING}/" >/dev/null | |
case ${{ matrix.job.target }} in | |
*-pc-windows-*) 7z -y a "${PKG_NAME}" "${PKG_BASENAME}"/* | tail -2 ;; | |
*) tar czf "${PKG_NAME}" "${PKG_BASENAME}"/* ;; | |
esac; | |
popd >/dev/null | |
# Let subsequent steps know where to find the compressed package | |
echo "PKG_PATH=${PKG_STAGING}/${PKG_NAME}" >> $GITHUB_OUTPUT | |
- name: Create Debian package | |
id: debian-package | |
shell: bash | |
if: startsWith(matrix.job.os, 'ubuntu') | |
run: bash scripts/create-deb.sh | |
env: | |
TARGET: ${{ matrix.job.target }} | |
DPKG_VERSION: ${{ needs.crate_metadata.version }} | |
BIN_PATH: ${{ steps.bin.outputs.BIN_PATH }} | |
- name: "Artifact upload: tarball" | |
uses: deep-soft/upload-artifact@v4 | |
with: | |
name: ${{ steps.package.outputs.PKG_NAME }} | |
path: ${{ steps.package.outputs.PKG_PATH }} | |
- name: "Artifact upload: Debian package" | |
uses: deep-soft/upload-artifact@v4 | |
if: steps.debian-package.outputs.DPKG_NAME | |
with: | |
name: ${{ steps.debian-package.outputs.DPKG_NAME }} | |
path: ${{ steps.debian-package.outputs.DPKG_PATH }} | |
- name: Check for release | |
id: is-release | |
shell: bash | |
run: | | |
unset IS_RELEASE ; if [[ $GITHUB_REF =~ ^refs/tags/v[0-9].* ]]; then IS_RELEASE='true' ; fi | |
echo "IS_RELEASE=${IS_RELEASE}" >> $GITHUB_OUTPUT | |
- name: Publish archives and packages | |
uses: deep-soft/[email protected] | |
#if: steps.is-release.outputs.IS_RELEASE | |
with: | |
tag_name: ${{ env.TAG_PREFIX }}${{ env.PROJECT_VERSION }}${{ env.TAG_SUFFIX }} | |
files: | | |
${{ steps.package.outputs.PKG_PATH }} | |
${{ steps.debian-package.outputs.DPKG_PATH }} | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
# winget: | |
# name: Publish to Winget | |
# runs-on: windows-latest # Action can only run on Windows | |
# needs: build | |
# if: startsWith(github.ref, 'refs/tags/v') | |
# steps: | |
# - uses: vedantmgoyal2009/winget-releaser@v2 | |
# with: | |
# identifier: sharkdp.fd | |
# installers-regex: '-pc-windows-msvc\.zip$' | |
# token: ${{ secrets.WINGET_TOKEN }} |