remove unused functions #563
Workflow file for this run
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
on: | |
push: | |
branches: [main] | |
tags: | |
- 'v*.*.*' | |
pull_request: | |
workflow_dispatch: | |
name: Continuous integration | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
env: | |
RUST_LOG: info | |
RUST_BACKTRACE: 1 | |
RUSTFLAGS: "-D warnings" | |
CARGO_TERM_COLOR: always | |
CICD_INTERMEDIATES_DIR: "_cicd-intermediates" | |
jobs: | |
check: | |
name: Check | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: Swatinem/rust-cache@v2 | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: 1.70.0 | |
- run: cargo check | |
# check-rustdoc-links: | |
# name: Check intra-doc links | |
# runs-on: ubuntu-latest | |
# steps: | |
# - uses: actions/checkout@v4 | |
# with: | |
# submodules: recursive | |
# - uses: dtolnay/rust-toolchain@master | |
# with: | |
# toolchain: 1.70.0 | |
# - run: | | |
# for package in $(cargo metadata --no-deps --format-version=1 | jq -r '.packages[] | .name'); do | |
# cargo rustdoc -p "$package" --all-features -- -D warnings -W unreachable-pub | |
# done | |
test: | |
name: Test Suite | |
runs-on: ${{ matrix.os }} | |
needs: check | |
strategy: | |
fail-fast: false | |
matrix: | |
os: ["ubuntu-latest", "windows-latest"] | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
# fetch all history so that the tests against v0.1.3 work | |
fetch-depth: 0 | |
# The tests require data that is stored in LFS | |
lfs: true | |
- uses: Swatinem/rust-cache@v2 | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: 1.70.0 | |
- run: cargo test --all-features -- --nocapture | |
build: | |
name: ${{ matrix.job.target }} (${{ matrix.job.os }}) | |
needs: [fmt, check] | |
runs-on: ${{ matrix.job.os }} | |
strategy: | |
fail-fast: false | |
matrix: | |
job: | |
# - { target: aarch64-unknown-linux-gnu , 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-11 } | |
- { target: aarch64-apple-darwin , os: macos-11 } | |
# - { 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 } | |
# - { target: x86_64-unknown-linux-musl , os: ubuntu-20.04, use-cross: true } | |
env: | |
BUILD_CMD: cargo | |
steps: | |
- name: Checkout source code | |
uses: actions/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=$(sed -n 's/^name = "\(.*\)"/\1/p' Cargo.toml | head -n1)" >> $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: dtolnay/rust-toolchain@master | |
with: | |
toolchain: 1.70.0 | |
targets: ${{ matrix.job.target }} | |
- name: Install cross | |
if: matrix.job.use-cross | |
uses: taiki-e/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: Add macOS cross build capability | |
if: matrix.job.target == 'aarch64-apple-darwin' | |
shell: bash | |
run: | | |
echo "SDKROOT=$(xcrun -sdk macosx --show-sdk-path)" >> $GITHUB_ENV | |
echo "MACOSX_DEPLOYMENT_TARGET=$(xcrun -sdk macosx --show-sdk-platform-version)" >> $GITHUB_ENV | |
rustup default stable-aarch64-apple-darwin | |
- 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: Set build options | |
id: build-options | |
shell: bash | |
run: | | |
unset CARGO_BUILD_OPTIONS | |
case ${{ matrix.job.target }} in | |
*-musl) CARGO_BUILD_OPTIONS="--no-default-features --features rustls-tls" ;; | |
*) CARGO_BUILD_OPTIONS="" ;; | |
esac | |
echo "CARGO_BUILD_OPTIONS=${CARGO_BUILD_OPTIONS}" >> $GITHUB_OUTPUT | |
- name: Build | |
uses: actions-rs/cargo@v1 | |
with: | |
use-cross: ${{ matrix.job.use-cross }} | |
command: build | |
args: --locked --release --target=${{ matrix.job.target }} ${{ steps.build-options.outputs.CARGO_BUILD_OPTIONS}} | |
- name: Strip debug information from executable | |
id: strip | |
shell: bash | |
run: | | |
# Figure out suffix of binary | |
EXE_suffix="" | |
case ${{ matrix.job.target }} in | |
*-pc-windows-*) EXE_suffix=".exe" ;; | |
esac; | |
# Figure out what strip tool to use if any | |
STRIP="strip" | |
case ${{ matrix.job.target }} in | |
arm-unknown-linux-*) STRIP="arm-linux-gnueabihf-strip" ;; | |
aarch64-unknown-linux-gnu) STRIP="aarch64-linux-gnu-strip" ;; | |
*-pc-windows-msvc) STRIP="" ;; | |
esac; | |
# Setup paths | |
BIN_DIR="${{ env.CICD_INTERMEDIATES_DIR }}/stripped-release-bin/" | |
mkdir -p "${BIN_DIR}" | |
BIN_NAME="${{ env.PROJECT_NAME }}${EXE_suffix}" | |
BIN_PATH="${BIN_DIR}/${BIN_NAME}" | |
# Copy the release build binary to the result location | |
cp "target/${{ matrix.job.target }}/release/${BIN_NAME}" "${BIN_DIR}" | |
# Also strip if possible | |
if [ -n "${STRIP}" ]; then | |
"${STRIP}" "${BIN_PATH}" | |
fi | |
# Let subsequent steps know where to find the (stripped) bin | |
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="--lib --bin ${PROJECT_NAME}" ;; esac; | |
echo "CARGO_TEST_OPTIONS=${CARGO_TEST_OPTIONS}" >> $GITHUB_OUTPUT | |
# - name: Run tests | |
# shell: bash | |
# if: matrix.job.target != 'aarch64-apple-darwin' | |
# run: $BUILD_CMD test --locked --target=${{ matrix.job.target }} ${{ steps.build-options.outputs.CARGO_BUILD_OPTIONS}} ${{ steps.test-options.outputs.CARGO_TEST_OPTIONS}} | |
- 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=${PROJECT_NAME}-v${PROJECT_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}" | |
# mkdir -p "${ARCHIVE_DIR}/autocomplete" | |
# Binary | |
cp "${{ steps.strip.outputs.BIN_PATH }}" "$ARCHIVE_DIR" | |
# README, LICENSE and CHANGELOG files | |
cp "README.md" "LICENSE" "$ARCHIVE_DIR" | |
# Autocompletion files | |
# cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.bash "$ARCHIVE_DIR/autocomplete/${{ env.PROJECT_NAME }}.bash" | |
# cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.fish "$ARCHIVE_DIR/autocomplete/${{ env.PROJECT_NAME }}.fish" | |
# cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/_bat.ps1 "$ARCHIVE_DIR/autocomplete/_${{ env.PROJECT_NAME }}.ps1" | |
# cp 'target/${{ matrix.job.target }}/release/build/${{ env.PROJECT_NAME }}'-*/out/assets/completions/bat.zsh "$ARCHIVE_DIR/autocomplete/${{ env.PROJECT_NAME }}.zsh" | |
# 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: "Artifact upload: tarball" | |
uses: actions/upload-artifact@master | |
with: | |
name: ${{ steps.package.outputs.PKG_NAME }} | |
path: ${{ steps.package.outputs.PKG_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: softprops/action-gh-release@v1 | |
if: steps.is-release.outputs.IS_RELEASE | |
with: | |
draft: true | |
files: | | |
${{ steps.package.outputs.PKG_PATH }} | |
${{ steps.debian-package.outputs.DPKG_PATH }} | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
fmt: | |
name: Rustfmt | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
components: rustfmt | |
toolchain: 1.70.0 | |
- uses: Swatinem/rust-cache@v2 | |
- run: cargo fmt --all -- --check | |
clippy: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: recursive | |
- uses: dtolnay/rust-toolchain@master | |
with: | |
components: clippy | |
toolchain: 1.70.0 | |
- uses: Swatinem/rust-cache@v2 | |
- uses: actions-rs/clippy-check@v1 | |
with: | |
token: ${{ secrets.GITHUB_TOKEN }} | |
args: --all-features -- -D warnings |