2020-01-28 01:59:40 +00:00
name : CICD
# spell-checker:ignore (acronyms) CICD MSVC musl
2020-11-07 19:09:06 +00:00
# spell-checker:ignore (env/flags) Awarnings Ccodegen Coverflow Cpanic RUSTDOCFLAGS RUSTFLAGS Zpanic
2020-04-10 06:19:19 +00:00
# spell-checker:ignore (jargon) SHAs deps softprops toolchain
2020-01-28 01:59:40 +00:00
# spell-checker:ignore (names) CodeCOV MacOS MinGW Peltoche rivy
2020-05-28 21:01:24 +00:00
# spell-checker:ignore (shell/tools) choco clippy dmake dpkg esac fakeroot gmake grcov halium lcov libssl mkdir popd printf pushd rustc rustfmt rustup shopt xargs
2021-06-05 21:07:56 +00:00
# spell-checker:ignore (misc) aarch alnum armhf bindir busytest coreutils gnueabihf issuecomment maint nullglob onexitbegin onexitend runtest tempfile testsuite uutils
2020-01-28 01:59:40 +00:00
env :
2020-05-25 03:24:56 +00:00
PROJECT_NAME : coreutils
PROJECT_DESC : "Core universal (cross-platform) utilities"
2020-01-28 01:59:40 +00:00
PROJECT_AUTH : "uutils"
2021-05-27 16:20:15 +00:00
RUST_MIN_SRV : "1.43.1" ## v1.43.0
2020-08-10 02:32:21 +00:00
RUST_COV_SRV : "2020-08-01" ## (~v1.47.0) supported rust version for code coverage; (date required/used by 'coverage') ## !maint: refactor when code coverage support is included in the stable channel
2020-01-28 01:59:40 +00:00
on : [ push, pull_request]
jobs :
2020-08-10 15:24:26 +00:00
code_format :
name : Style/format
2020-01-28 01:59:40 +00:00
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : false
matrix :
job :
2020-08-10 15:24:26 +00:00
- { os: ubuntu-latest , features : feat_os_unix }
2020-01-28 01:59:40 +00:00
steps :
- uses : actions/checkout@v1
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2021-05-31 21:01:54 +00:00
outputs() { for var in "$@" ; do echo steps.vars.outputs.${var}="${!var}"; echo ::set-output name=${var}::${!var}; done; }
2020-03-10 19:23:15 +00:00
# target-specific options
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='' ;
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
2021-05-31 21:01:54 +00:00
outputs CARGO_FEATURES_OPTION
2020-01-28 01:59:40 +00:00
- name : Install `rust` toolchain
uses : actions-rs/toolchain@v1
with :
toolchain : stable
2020-05-02 21:53:47 +00:00
default : true
2020-01-28 01:59:40 +00:00
profile : minimal # minimal component installation (ie, no documentation)
2020-08-10 14:53:32 +00:00
components : rustfmt
2020-01-28 01:59:40 +00:00
- name : "`fmt` testing"
2020-05-02 21:53:47 +00:00
shell : bash
run : |
# `fmt` testing
2020-05-03 04:12:50 +00:00
# * convert any warnings to GHA UI annotations; ref: <https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message>
2020-05-02 21:53:47 +00:00
S=$(cargo fmt -- --check) && printf "%s\n" "$S" || { printf "%s\n" "$S" | sed -E -n -e "s/^Diff[[:space:]]+in[[:space:]]+${PWD//\//\\/}\/(.*)[[:space:]]+at[[:space:]]+[^0-9]+([0-9]+).*$/::warning file=\1,line=\2::WARNING: \`cargo fmt\`: style violation/p" ; }
2020-04-13 23:08:40 +00:00
- name : "`fmt` testing of tests"
shell : bash
run : |
2020-05-02 21:53:47 +00:00
# `fmt` testing of tests
2020-05-03 04:12:50 +00:00
# * convert any warnings to GHA UI annotations; ref: <https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message>
2020-05-02 21:53:47 +00:00
S=$(find tests -name "*.rs" -print0 | xargs -0 cargo fmt -- --check) && printf "%s\n" "$S" || { printf "%s\n" "$S" | sed -E -n "s/^Diff[[:space:]]+in[[:space:]]+${PWD//\//\\/}\/(.*)[[:space:]]+at[[:space:]]+[^0-9]+([0-9]+).*$/::warning file=\1,line=\2::WARNING: \`cargo fmt\`: style violation/p" ; }
2020-08-10 14:53:32 +00:00
2021-05-31 04:18:46 +00:00
code_spellcheck :
name : Style/spelling
runs-on : ${{ matrix.job.os }}
strategy :
matrix :
job :
- { os : ubuntu-latest }
steps :
- uses : actions/checkout@v1
- name : Install/setup prerequisites
shell : bash
run : |
sudo apt-get -y update ; sudo apt-get -y install npm ; sudo npm install cspell -g;
- name : Run `cspell`
shell : bash
run : |
2021-05-31 20:23:40 +00:00
cspell --config .vscode/cSpell.json --no-summary --no-progress "**/*" | sed "s/\(.*\):\(.*\):\(.*\) - \(.*\)/::warning file=\1,line=\2,col=\3::cspell: \4/" || true
2021-05-31 04:18:46 +00:00
2020-08-10 15:24:26 +00:00
code_warnings :
name : Style/warnings
2020-08-10 14:53:32 +00:00
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : false
matrix :
job :
2020-08-10 15:24:26 +00:00
- { os: ubuntu-latest , features : feat_os_unix }
- { os: macos-latest , features : feat_os_macos }
- { os: windows-latest , features : feat_os_windows }
2020-08-10 14:53:32 +00:00
steps :
- uses : actions/checkout@v1
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2021-05-31 21:01:54 +00:00
outputs() { for var in "$@" ; do echo steps.vars.outputs.${var}="${!var}"; echo ::set-output name=${var}::${!var}; done; }
2020-08-10 14:53:32 +00:00
# target-specific options
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='' ;
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
2021-05-31 21:01:54 +00:00
outputs CARGO_FEATURES_OPTION
2020-08-10 14:53:32 +00:00
- name : Install `rust` toolchain
uses : actions-rs/toolchain@v1
with :
2021-05-30 07:29:10 +00:00
toolchain : nightly
2020-08-10 14:53:32 +00:00
default : true
profile : minimal # minimal component installation (ie, no documentation)
components : clippy
2020-01-28 01:59:40 +00:00
- name : "`clippy` testing"
2020-04-13 23:08:40 +00:00
if : success() || failure() # run regardless of prior step success/failure
2020-05-02 21:53:47 +00:00
shell : bash
run : |
# `clippy` testing
2020-05-03 04:12:50 +00:00
# * convert any warnings to GHA UI annotations; ref: <https://help.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message>
2021-05-30 07:29:10 +00:00
S=$(cargo +nightly clippy --all-targets ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} -- -D warnings 2>&1) && printf "%s\n" "$S" || { printf "%s\n" "$S" ; printf "%s" "$S" | sed -E -n -e '/^error:/{' -e "N; s/^error:[[:space:]]+(.*)\\n[[:space:]]+-->[[:space:]]+(.*):([0-9]+):([0-9]+).*$/::warning file=\2,line=\3,col=\4::WARNING: \`cargo clippy\`: \1/p;" -e '}' ; }
2020-01-28 01:59:40 +00:00
min_version :
2020-05-22 15:29:42 +00:00
name : MinRustV # Minimum supported rust version
2020-04-08 16:30:31 +00:00
runs-on : ${{ matrix.job.os }}
strategy :
matrix :
job :
- { os: ubuntu-latest , features : feat_os_unix }
2020-01-28 01:59:40 +00:00
steps :
- uses : actions/checkout@v1
- name : Install `rust` toolchain (v${{ env.RUST_MIN_SRV }})
uses : actions-rs/toolchain@v1
with :
toolchain : ${{ env.RUST_MIN_SRV }}
2020-03-18 05:02:54 +00:00
default : true
2020-01-28 01:59:40 +00:00
profile : minimal # minimal component installation (ie, no documentation)
2020-04-08 16:30:31 +00:00
- name : Install `cargo-tree` # for dependency information
uses : actions-rs/install@v0.1
with :
crate : cargo-tree
version : latest
use-tool-cache : true
env :
RUSTUP_TOOLCHAIN : stable
2020-10-23 15:25:18 +00:00
- name : Confirm compatible 'Cargo.lock'
shell : bash
run : |
# Confirm compatible 'Cargo.lock'
# * 'Cargo.lock' is required to be in a format that `cargo` of MinSRV can interpret (eg, v1-format for MinSRV < v1.38)
cargo fetch --locked --quiet || { echo "::error file=Cargo.lock::Incompatible 'Cargo.lock' format; try \`cargo +${{ env.RUST_MIN_SRV }} update\`" ; exit 1 ; }
2020-04-08 16:30:31 +00:00
- name : Info
shell : bash
run : |
# Info
2020-06-14 00:38:24 +00:00
## environment
echo "## environment"
echo "CI='${CI}'"
2020-04-08 16:30:31 +00:00
## tooling info display
echo "## tooling"
which gcc >/dev/null 2>&1 && (gcc --version | head -1) || true
rustup -V
rustup show active-toolchain
cargo -V
rustc -V
2020-04-15 05:34:40 +00:00
cargo-tree tree -V
2020-04-08 16:30:31 +00:00
## dependencies
echo "## dependency list"
2020-10-23 15:25:18 +00:00
cargo fetch --locked --quiet
2020-04-15 05:34:40 +00:00
## * using the 'stable' toolchain is necessary to avoid "unexpected '--filter-platform'" errors
2020-10-15 02:41:13 +00:00
RUSTUP_TOOLCHAIN=stable cargo-tree tree --frozen --all --no-dev-dependencies --no-indent --features ${{ matrix.job.features }} | grep -vE "$PWD" | sort --unique
2020-10-23 15:25:18 +00:00
2020-01-28 01:59:40 +00:00
- name : Test
uses : actions-rs/cargo@v1
with :
command : test
2021-04-05 15:16:00 +00:00
args : --features "feat_os_unix" -p uucore -p coreutils
2020-08-10 14:53:32 +00:00
env :
RUSTFLAGS : '-Awarnings'
2020-01-28 01:59:40 +00:00
2021-03-14 19:30:53 +00:00
busybox_test :
name : Busybox test suite
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : false
matrix :
job :
- { os : ubuntu-latest }
steps :
- uses : actions/checkout@v1
- name : Install `rust` toolchain
uses : actions-rs/toolchain@v1
with :
toolchain : stable
default : true
profile : minimal # minimal component installation (ie, no documentation)
- name : "prepare busytest"
shell : bash
run : |
make prepare-busytest
- name : "run busybox testsuite"
shell : bash
run : |
bindir=$(pwd)/target/debug
cd tmp/busybox-*/testsuite
2021-06-06 16:22:42 +00:00
## S=$(bindir=$bindir ./runtest) && printf "%s\n" "$S" || { printf "%s\n" "$S" | grep "FAIL:" | sed -e "s/FAIL: /::warning ::Test failure:/g" ; }
output=$(bindir=$bindir ./runtest 2>&1 || true)
printf "%s\n" "${output}"
n_fails=$(echo "$output" | grep "^FAIL:\s" | wc --lines)
if [ $n_fails -gt 0 ] ; then echo "::warning ::${n_fails}+ test failures" ; fi
2021-03-14 19:30:53 +00:00
2021-04-02 20:22:50 +00:00
makefile_build :
name : Test the build target of the Makefile
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : false
matrix :
job :
- { os : ubuntu-latest }
steps :
- uses : actions/checkout@v1
- name : Install `rust` toolchain
uses : actions-rs/toolchain@v1
with :
toolchain : stable
default : true
profile : minimal # minimal component installation (ie, no documentation)
- name : "Run make build"
shell : bash
run : |
sudo apt-get -y update ; sudo apt-get -y install python3-sphinx;
make build
2020-01-28 01:59:40 +00:00
build :
name : Build
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : false
matrix :
job :
# { os, target, cargo-options, features, use-cross, toolchain }
- { os: ubuntu-latest , target: arm-unknown-linux-gnueabihf , features: feat_os_unix_gnueabihf , use-cross : use-cross }
2020-05-28 21:01:24 +00:00
- { os: ubuntu-latest , target: aarch64-unknown-linux-gnu , features: feat_os_unix_gnueabihf , use-cross : use-cross }
2021-06-13 13:39:31 +00:00
- { os: ubuntu-latest , target: x86_64-unknown-linux-gnu , features: feat_os_unix , use-cross : use-cross }
2020-01-28 01:59:40 +00:00
- { os: ubuntu-16.04 , target: x86_64-unknown-linux-gnu , features: feat_os_unix , use-cross : use-cross }
2020-06-01 14:10:21 +00:00
# - { os: ubuntu-18.04 , target: i586-unknown-linux-gnu , features: feat_os_unix , use-cross: use-cross } ## note: older windows platform; not required, dev-FYI only
# - { os: ubuntu-18.04 , target: i586-unknown-linux-gnu , features: feat_os_unix , use-cross: use-cross } ## note: older windows platform; not required, dev-FYI only
2020-01-28 01:59:40 +00:00
- { os: ubuntu-18.04 , target: i686-unknown-linux-gnu , features: feat_os_unix , use-cross : use-cross }
- { os: ubuntu-18.04 , target: i686-unknown-linux-musl , features: feat_os_unix_musl , use-cross : use-cross }
- { os: ubuntu-18.04 , target: x86_64-unknown-linux-gnu , features: feat_os_unix , use-cross : use-cross }
- { os: ubuntu-18.04 , target: x86_64-unknown-linux-musl , features: feat_os_unix_musl , use-cross : use-cross }
2020-04-20 03:06:51 +00:00
- { os: macos-latest , target: x86_64-apple-darwin , features : feat_os_macos }
2020-01-28 01:59:40 +00:00
- { os: windows-latest , target: i686-pc-windows-gnu , features : feat_os_windows }
- { os: windows-latest , target: i686-pc-windows-msvc , features : feat_os_windows }
2020-05-02 21:44:36 +00:00
- { os: windows-latest , target: x86_64-pc-windows-gnu , features: feat_os_windows } ## note : requires rust >= 1.43.0 to link correctly
2020-01-28 01:59:40 +00:00
- { os: windows-latest , target: x86_64-pc-windows-msvc , features : feat_os_windows }
steps :
- uses : actions/checkout@v1
- name : Install/setup prerequisites
shell : bash
run : |
## install/setup prerequisites
case '${{ matrix.job.target }}' in
arm-unknown-linux-gnueabihf) sudo apt-get -y update ; sudo apt-get -y install gcc-arm-linux-gnueabihf ;;
2020-05-28 21:01:24 +00:00
aarch64-unknown-linux-gnu) sudo apt-get -y update ; sudo apt-get -y install gcc-aarch64-linux-gnu ;;
2020-01-28 01:59:40 +00:00
esac
2021-05-17 20:22:18 +00:00
case '${{ matrix.job.os }}' in
macos-latest) brew install coreutils ;; # needed for testing
esac
2020-01-28 01:59:40 +00:00
- name : Initialize workflow variables
id : vars
shell : bash
run : |
## VARs setup
2021-05-31 21:01:54 +00:00
outputs() { for var in "$@" ; do echo steps.vars.outputs.${var}="${!var}"; echo ::set-output name=${var}::${!var}; done; }
2020-01-28 01:59:40 +00:00
# toolchain
TOOLCHAIN="stable" ## default to "stable" toolchain
# * specify alternate/non-default TOOLCHAIN for *-pc-windows-gnu targets; gnu targets on Windows are broken for the standard *-pc-windows-msvc toolchain (refs: GH:rust-lang/rust#47048, GH:rust-lang/rust#53454, GH:rust-lang/cargo#6754)
case ${{ matrix.job.target }} in *-pc-windows-gnu) TOOLCHAIN="stable-${{ matrix.job.target }}" ;; esac;
# * use requested TOOLCHAIN if specified
if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
2021-05-31 21:01:54 +00:00
outputs TOOLCHAIN
2020-01-28 01:59:40 +00:00
# staging directory
STAGING='_staging'
2021-05-31 21:01:54 +00:00
outputs STAGING
2020-01-28 01:59:40 +00:00
# determine EXE suffix
EXE_suffix="" ; case '${{ matrix.job.target }}' in *-pc-windows-*) EXE_suffix=".exe" ;; esac;
2021-05-31 21:01:54 +00:00
outputs EXE_suffix
2020-01-28 01:59:40 +00:00
# parse commit reference info
2020-04-10 13:40:41 +00:00
echo GITHUB_REF=${GITHUB_REF}
echo GITHUB_SHA=${GITHUB_SHA}
2020-01-28 01:59:40 +00:00
REF_NAME=${GITHUB_REF#refs/*/}
2020-04-10 13:40:41 +00:00
unset REF_BRANCH ; case "${GITHUB_REF}" in refs/heads/*) REF_BRANCH=${GITHUB_REF#refs/heads/} ;; esac;
unset REF_TAG ; case "${GITHUB_REF}" in refs/tags/*) REF_TAG=${GITHUB_REF#refs/tags/} ;; esac;
2020-01-28 01:59:40 +00:00
REF_SHAS=${GITHUB_SHA:0:8}
2021-05-31 21:01:54 +00:00
outputs REF_NAME REF_BRANCH REF_TAG REF_SHAS
2020-01-28 01:59:40 +00:00
# parse target
2020-05-28 21:01:24 +00:00
unset TARGET_ARCH
case '${{ matrix.job.target }}' in
aarch64-*) TARGET_ARCH=arm64 ;;
arm-*-*hf) TARGET_ARCH=armhf ;;
i586-*) TARGET_ARCH=i586 ;;
i686-*) TARGET_ARCH=i686 ;;
x86_64-*) TARGET_ARCH=x86_64 ;;
esac;
2020-01-28 01:59:40 +00:00
unset TARGET_OS ; case '${{ matrix.job.target }}' in *-linux-*) TARGET_OS=linux ;; *-apple-*) TARGET_OS=macos ;; *-windows-*) TARGET_OS=windows ;; esac;
2021-05-31 21:01:54 +00:00
outputs TARGET_ARCH TARGET_OS
2020-01-28 01:59:40 +00:00
# package name
PKG_suffix=".tar.gz" ; case '${{ matrix.job.target }}' in *-pc-windows-*) PKG_suffix=".zip" ;; esac;
PKG_BASENAME=${PROJECT_NAME}-${REF_TAG:-$REF_SHAS}-${{ matrix.job.target }}
PKG_NAME=${PKG_BASENAME}${PKG_suffix}
2021-05-31 21:01:54 +00:00
outputs PKG_suffix PKG_BASENAME PKG_NAME
2020-01-28 01:59:40 +00:00
# deployable tag? (ie, leading "vM" or "M"; M == version number)
2020-05-28 21:01:24 +00:00
unset DEPLOY ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DEPLOY='true' ; fi
2021-05-31 21:01:54 +00:00
outputs DEPLOY
2020-05-28 21:01:24 +00:00
# DPKG architecture?
unset DPKG_ARCH
case ${{ matrix.job.target }} in
x86_64-*-linux-*) DPKG_ARCH=amd64 ;;
*-linux-*) DPKG_ARCH=${TARGET_ARCH} ;;
esac
2021-05-31 21:01:54 +00:00
outputs DPKG_ARCH
2020-05-28 21:01:24 +00:00
# DPKG version?
unset DPKG_VERSION ; if [[ $REF_TAG =~ ^[vV]?[0-9].* ]]; then DPKG_VERSION=${REF_TAG/#[vV]/} ; fi
2021-05-31 21:01:54 +00:00
outputs DPKG_VERSION
2020-05-28 21:01:24 +00:00
# DPKG base name/conflicts?
DPKG_BASENAME=${PROJECT_NAME}
DPKG_CONFLICTS=${PROJECT_NAME}-musl
case ${{ matrix.job.target }} in *-musl) DPKG_BASENAME=${PROJECT_NAME}-musl ; DPKG_CONFLICTS=${PROJECT_NAME} ;; esac;
2021-05-31 21:01:54 +00:00
outputs DPKG_BASENAME DPKG_CONFLICTS
2020-05-28 21:01:24 +00:00
# DPKG name
unset DPKG_NAME;
if [[ -n $DPKG_ARCH && -n $DPKG_VERSION ]]; then DPKG_NAME="${DPKG_BASENAME}_${DPKG_VERSION}_${DPKG_ARCH}.deb" ; fi
2021-05-31 21:01:54 +00:00
outputs DPKG_NAME
2020-01-28 01:59:40 +00:00
# target-specific options
2020-03-10 19:23:15 +00:00
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='' ;
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
2021-05-31 21:01:54 +00:00
outputs CARGO_FEATURES_OPTION
2020-01-28 01:59:40 +00:00
# * CARGO_USE_CROSS (truthy)
CARGO_USE_CROSS='true' ; case '${{ matrix.job.use-cross }}' in ''|0|f|false|n|no) unset CARGO_USE_CROSS ;; esac;
2021-05-31 21:01:54 +00:00
outputs CARGO_USE_CROSS
2020-06-14 00:38:24 +00:00
# ** pass needed environment into `cross` container (iff `cross` not already configured via "Cross.toml")
if [ -n "${CARGO_USE_CROSS}" ] && [ ! -e "Cross.toml" ] ; then
printf "[build.env]\npassthrough = [\"CI\"]\n" > Cross.toml
fi
2020-05-28 21:01:24 +00:00
# * test only library and/or binaries for arm-type targets
unset CARGO_TEST_OPTIONS ; case '${{ matrix.job.target }}' in aarch64-* | arm-*) CARGO_TEST_OPTIONS="--bins" ;; esac;
2021-05-31 21:01:54 +00:00
outputs CARGO_TEST_OPTIONS
2020-05-28 21:01:24 +00:00
# * executable for `strip`?
STRIP="strip"
case ${{ matrix.job.target }} in
aarch64-*-linux-gnu) STRIP="aarch64-linux-gnu-strip" ;;
arm-*-linux-gnueabihf) STRIP="arm-linux-gnueabihf-strip" ;;
*-pc-windows-msvc) STRIP="" ;;
esac;
2021-05-31 21:01:54 +00:00
outputs STRIP
2020-01-28 01:59:40 +00:00
- name : Create all needed build/work directories
shell : bash
run : |
## create build/work space
mkdir -p '${{ steps.vars.outputs.STAGING }}'
mkdir -p '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}'
2020-05-28 21:01:24 +00:00
mkdir -p '${{ steps.vars.outputs.STAGING }}/dpkg'
2020-01-28 01:59:40 +00:00
- name : rust toolchain ~ install
uses : actions-rs/toolchain@v1
2021-05-23 08:19:25 +00:00
env :
# Override auto-detection of RAM for Rustc install.
# https://github.com/rust-lang/rustup/issues/2229#issuecomment-585855925
RUSTUP_UNPACK_RAM : "21474836480"
2020-01-28 01:59:40 +00:00
with :
toolchain : ${{ steps.vars.outputs.TOOLCHAIN }}
target : ${{ matrix.job.target }}
default : true
profile : minimal # minimal component installation (ie, no documentation)
2020-08-03 15:08:15 +00:00
- name : Initialize toolchain-dependent workflow variables
id : dep_vars
shell : bash
run : |
## Dependent VARs setup
2021-05-31 21:01:54 +00:00
outputs() { for var in "$@" ; do echo steps.vars.outputs.${var}="${!var}"; echo ::set-output name=${var}::${!var}; done; }
2020-08-03 15:08:15 +00:00
# * determine sub-crate utility list
UTILITY_LIST="$(./util/show-utils.sh ${CARGO_FEATURES_OPTION})"
2021-05-31 21:01:54 +00:00
echo UTILITY_LIST=${UTILITY_LIST}
2020-08-03 15:08:15 +00:00
CARGO_UTILITY_LIST_OPTIONS="$(for u in ${UTILITY_LIST}; do echo "-puu_${u}"; done;)"
2021-05-31 21:01:54 +00:00
outputs CARGO_UTILITY_LIST_OPTIONS
2020-04-08 16:30:31 +00:00
- name : Install `cargo-tree` # for dependency information
uses : actions-rs/install@v0.1
with :
crate : cargo-tree
version : latest
use-tool-cache : true
env :
RUSTUP_TOOLCHAIN : stable
2020-01-28 01:59:40 +00:00
- name : Info
shell : bash
run : |
2020-04-08 16:30:31 +00:00
# Info
2020-04-08 19:52:03 +00:00
## commit info
echo "## commit"
echo GITHUB_REF=${GITHUB_REF}
echo GITHUB_SHA=${GITHUB_SHA}
2020-06-14 00:38:24 +00:00
## environment
echo "## environment"
echo "CI='${CI}'"
2020-01-28 01:59:40 +00:00
## tooling info display
2020-04-08 16:30:31 +00:00
echo "## tooling"
2020-01-28 01:59:40 +00:00
which gcc >/dev/null 2>&1 && (gcc --version | head -1) || true
rustup -V
2020-04-08 16:30:31 +00:00
rustup show active-toolchain
2020-01-28 01:59:40 +00:00
cargo -V
rustc -V
2020-04-15 05:34:40 +00:00
cargo-tree tree -V
2020-04-08 16:30:31 +00:00
## dependencies
echo "## dependency list"
2020-10-23 15:25:18 +00:00
cargo fetch --locked --quiet
2020-04-15 05:34:40 +00:00
cargo-tree tree --target=${{ matrix.job.target }} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --all --no-dev-dependencies --no-indent | grep -vE "$PWD" | sort --unique
2020-01-28 01:59:40 +00:00
- name : Build
uses : actions-rs/cargo@v1
with :
use-cross : ${{ steps.vars.outputs.CARGO_USE_CROSS }}
command : build
2020-03-10 19:23:15 +00:00
args : --release --target=${{ matrix.job.target }} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
2020-01-28 01:59:40 +00:00
- name : Test
uses : actions-rs/cargo@v1
with :
use-cross : ${{ steps.vars.outputs.CARGO_USE_CROSS }}
command : test
2020-03-10 19:23:15 +00:00
args : --target=${{ matrix.job.target }} ${{ steps.vars.outputs.CARGO_TEST_OPTIONS}} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }}
2020-08-03 15:08:15 +00:00
- name : Test individual utilities
uses : actions-rs/cargo@v1
with :
use-cross : ${{ steps.vars.outputs.CARGO_USE_CROSS }}
command : test
args : --target=${{ matrix.job.target }} ${{ steps.vars.outputs.CARGO_TEST_OPTIONS}} ${{ matrix.job.cargo-options }} ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} ${{ steps.dep_vars.outputs.CARGO_UTILITY_LIST_OPTIONS }}
2020-01-28 01:59:40 +00:00
- name : Archive executable artifacts
2020-07-25 02:57:53 +00:00
uses : actions/upload-artifact@v2
2020-01-28 01:59:40 +00:00
with :
name : ${{ env.PROJECT_NAME }}-${{ matrix.job.target }}
path : target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}
- name : Package
shell : bash
run : |
## package artifact(s)
# binary
cp 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/'
# `strip` binary (if needed)
if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' ; fi
# README and LICENSE
2020-03-18 05:05:58 +00:00
# * spell-checker:ignore EADME ICENSE
(shopt -s nullglob; for f in [R]"EADME"{,.*}; do cp $f '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/' ; done)
(shopt -s nullglob; for f in [L]"ICENSE"{-*,}{,.*}; do cp $f '${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_BASENAME }}/' ; done)
2020-01-28 01:59:40 +00:00
# core compressed package
pushd '${{ steps.vars.outputs.STAGING }}/' >/dev/null
case '${{ matrix.job.target }}' in
*-pc-windows-*) 7z -y a '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* | tail -2 ;;
*) tar czf '${{ steps.vars.outputs.PKG_NAME }}' '${{ steps.vars.outputs.PKG_BASENAME }}'/* ;;
esac
popd >/dev/null
2020-05-28 21:01:24 +00:00
# dpkg
if [ -n "${{ steps.vars.outputs.DPKG_NAME }}" ]; then
DPKG_DIR="${{ steps.vars.outputs.STAGING }}/dpkg"
# binary
install -Dm755 'target/${{ matrix.job.target }}/release/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}' "${DPKG_DIR}/usr/bin/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}"
if [ -n "${{ steps.vars.outputs.STRIP }}" ]; then "${{ steps.vars.outputs.STRIP }}" "${DPKG_DIR}/usr/bin/${{ env.PROJECT_NAME }}${{ steps.vars.outputs.EXE_suffix }}" ; fi
# README and LICENSE
(shopt -s nullglob; for f in [R]"EADME"{,.*}; do install -Dm644 "$f" "${DPKG_DIR}/usr/share/doc/${{ env.PROJECT_NAME }}/$f" ; done)
(shopt -s nullglob; for f in [L]"ICENSE"{-*,}{,.*}; do install -Dm644 "$f" "${DPKG_DIR}/usr/share/doc/${{ env.PROJECT_NAME }}/$f" ; done)
# control file
mkdir -p "${DPKG_DIR}/DEBIAN"
printf "Package: ${{ steps.vars.outputs.DPKG_BASENAME }}\nVersion: ${{ steps.vars.outputs.DPKG_VERSION }}\nSection: utils\nPriority: optional\nMaintainer: ${{ env.PROJECT_AUTH }}\nArchitecture: ${{ steps.vars.outputs.DPKG_ARCH }}\nProvides: ${{ env.PROJECT_NAME }}\nConflicts: ${{ steps.vars.outputs.DPKG_CONFLICTS }}\nDescription: ${{ env.PROJECT_DESC }}\n" > "${DPKG_DIR}/DEBIAN/control"
# build dpkg
fakeroot dpkg-deb --build "${DPKG_DIR}" "${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.DPKG_NAME }}"
fi
2020-01-28 01:59:40 +00:00
- name : Publish
uses : softprops/action-gh-release@v1
2020-05-28 21:01:24 +00:00
if : steps.vars.outputs.DEPLOY
2020-01-28 01:59:40 +00:00
with :
files : |
${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.PKG_NAME }}
2020-05-28 21:01:24 +00:00
${{ steps.vars.outputs.STAGING }}/${{ steps.vars.outputs.DPKG_NAME }}
2020-01-28 01:59:40 +00:00
env :
GITHUB_TOKEN : ${{ secrets.GITHUB_TOKEN }}
coverage :
name : Code Coverage
runs-on : ${{ matrix.job.os }}
strategy :
fail-fast : true
matrix :
# job: [ { os: ubuntu-latest }, { os: macos-latest }, { os: windows-latest } ]
2020-04-08 19:52:03 +00:00
job :
- { os: ubuntu-latest , features : unix }
2020-04-20 03:06:51 +00:00
- { os: macos-latest , features : macos }
2020-05-02 21:52:28 +00:00
- { os: windows-latest , features : windows }
2020-01-28 01:59:40 +00:00
steps :
- uses : actions/checkout@v1
2021-05-21 10:39:48 +00:00
- name : Install/setup prerequisites
shell : bash
run : |
## install/setup prerequisites
case '${{ matrix.job.os }}' in
macos-latest) brew install coreutils ;; # needed for testing
esac
2020-01-28 01:59:40 +00:00
# - name: Reattach HEAD ## may be needed for accurate code coverage info
# run: git checkout ${{ github.head_ref }}
- name : Initialize workflow variables
id : vars
shell : bash
run : |
2021-05-31 21:01:54 +00:00
## VARs setup
outputs() { for var in "$@" ; do echo steps.vars.outputs.${var}="${!var}"; echo ::set-output name=${var}::${!var}; done; }
2020-04-08 19:52:03 +00:00
# toolchain
2020-05-02 21:52:28 +00:00
TOOLCHAIN="nightly-${{ env.RUST_COV_SRV }}" ## default to "nightly" toolchain (required for certain required unstable compiler flags) ## !maint: refactor when stable channel has needed support
# * specify gnu-type TOOLCHAIN for windows; `grcov` requires gnu-style code coverage data files
case ${{ matrix.job.os }} in windows-*) TOOLCHAIN="$TOOLCHAIN-x86_64-pc-windows-gnu" ;; esac;
2020-04-08 19:52:03 +00:00
# * use requested TOOLCHAIN if specified
if [ -n "${{ matrix.job.toolchain }}" ]; then TOOLCHAIN="${{ matrix.job.toolchain }}" ; fi
2021-05-31 21:01:54 +00:00
outputs TOOLCHAIN
2020-01-28 01:59:40 +00:00
# staging directory
STAGING='_staging'
2021-05-31 21:01:54 +00:00
outputs STAGING
2020-04-08 19:52:03 +00:00
## # check for CODECOV_TOKEN availability (work-around for inaccessible 'secrets' object for 'if'; see <https://github.community/t5/GitHub-Actions/jobs-lt-job-id-gt-if-does-not-work-with-env-secrets/m-p/38549>)
## # note: CODECOV_TOKEN / HAS_CODECOV_TOKEN is not needed for public repositories when using AppVeyor, Azure Pipelines, CircleCI, GitHub Actions, Travis (see <https://docs.codecov.io/docs/about-the-codecov-bash-uploader#section-upload-token>)
## unset HAS_CODECOV_TOKEN
## if [ -n $CODECOV_TOKEN ]; then HAS_CODECOV_TOKEN='true' ; fi
2021-05-31 21:01:54 +00:00
## outputs HAS_CODECOV_TOKEN
2020-04-08 19:52:03 +00:00
# target-specific options
# * CARGO_FEATURES_OPTION
CARGO_FEATURES_OPTION='--all-features' ; ## default to '--all-features' for code coverage
if [ -n "${{ matrix.job.features }}" ]; then CARGO_FEATURES_OPTION='--features "${{ matrix.job.features }}"' ; fi
2021-05-31 21:01:54 +00:00
outputs CARGO_FEATURES_OPTION
2020-04-08 19:52:03 +00:00
# * CODECOV_FLAGS
CODECOV_FLAGS=$( echo "${{ matrix.job.os }}" | sed 's/[^[:alnum:]]/_/g' )
2021-05-31 21:01:54 +00:00
outputs CODECOV_FLAGS
2020-04-08 19:52:03 +00:00
- name : rust toolchain ~ install
uses : actions-rs/toolchain@v1
with :
toolchain : ${{ steps.vars.outputs.TOOLCHAIN }}
default : true
profile : minimal # minimal component installation (ie, no documentation)
2020-08-09 04:38:41 +00:00
- name : Initialize toolchain-dependent workflow variables
id : dep_vars
shell : bash
run : |
## Dependent VARs setup
2021-05-31 21:01:54 +00:00
outputs() { for var in "$@" ; do echo steps.vars.outputs.${var}="${!var}"; echo ::set-output name=${var}::${!var}; done; }
2020-08-09 04:38:41 +00:00
# * determine sub-crate utility list
UTILITY_LIST="$(./util/show-utils.sh ${CARGO_FEATURES_OPTION})"
CARGO_UTILITY_LIST_OPTIONS="$(for u in ${UTILITY_LIST}; do echo "-puu_${u}"; done;)"
2021-05-31 21:01:54 +00:00
outputs CARGO_UTILITY_LIST_OPTIONS
2021-04-05 15:16:00 +00:00
- name : Test uucore
uses : actions-rs/cargo@v1
with :
command : test
args : ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --no-fail-fast -p uucore
env :
CARGO_INCREMENTAL : '0'
RUSTC_WRAPPER : ''
RUSTFLAGS : '-Zprofile -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=abort'
RUSTDOCFLAGS : '-Cpanic=abort'
# RUSTUP_TOOLCHAIN: ${{ steps.vars.outputs.TOOLCHAIN }}
2020-04-08 19:52:03 +00:00
- name : Test
uses : actions-rs/cargo@v1
with :
command : test
args : ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --no-fail-fast
2020-01-28 01:59:40 +00:00
env :
2020-04-08 19:52:03 +00:00
CARGO_INCREMENTAL : '0'
RUSTC_WRAPPER : ''
2020-08-10 02:32:21 +00:00
RUSTFLAGS : '-Zprofile -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=abort'
RUSTDOCFLAGS : '-Cpanic=abort'
2020-04-08 19:52:03 +00:00
# RUSTUP_TOOLCHAIN: ${{ steps.vars.outputs.TOOLCHAIN }}
2020-08-09 04:38:41 +00:00
- name : Test individual utilities
uses : actions-rs/cargo@v1
with :
command : test
args : ${{ steps.vars.outputs.CARGO_FEATURES_OPTION }} --no-fail-fast ${{ steps.dep_vars.outputs.CARGO_UTILITY_LIST_OPTIONS }}
env :
CARGO_INCREMENTAL : '0'
RUSTC_WRAPPER : ''
2020-08-10 02:32:21 +00:00
RUSTFLAGS : '-Zprofile -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=abort'
RUSTDOCFLAGS : '-Cpanic=abort'
2020-08-09 04:38:41 +00:00
# RUSTUP_TOOLCHAIN: ${{ steps.vars.outputs.TOOLCHAIN }}
2020-04-08 19:52:03 +00:00
- name : "`grcov` ~ install"
uses : actions-rs/install@v0.1
with :
crate : grcov
version : latest
2021-05-31 20:33:49 +00:00
use-tool-cache : false
2020-04-08 19:52:03 +00:00
- name : Generate coverage data (via `grcov`)
id : coverage
shell : bash
2020-01-28 01:59:40 +00:00
run : |
2020-04-08 19:52:03 +00:00
# generate coverage data
COVERAGE_REPORT_DIR="target/debug"
COVERAGE_REPORT_FILE="${COVERAGE_REPORT_DIR}/lcov.info"
2020-08-10 06:06:54 +00:00
# GRCOV_IGNORE_OPTION='--ignore build.rs --ignore "/*" --ignore "[a-zA-Z]:/*"' ## `grcov` ignores these params when passed as an environment variable (why?)
# GRCOV_EXCLUDE_OPTION='--excl-br-line "^\s*((debug_)?assert(_eq|_ne)?!|#\[derive\()"' ## `grcov` ignores these params when passed as an environment variable (why?)
2020-04-08 19:52:03 +00:00
mkdir -p "${COVERAGE_REPORT_DIR}"
2020-08-10 06:06:54 +00:00
# display coverage files
grcov . --output-type files --ignore build.rs --ignore "/*" --ignore "[a-zA-Z]:/*" --excl-br-line "^\s*((debug_)?assert(_eq|_ne)?!|#\[derive\()" | sort --unique
# generate coverage report
grcov . --output-type lcov --output-path "${COVERAGE_REPORT_FILE}" --branch --ignore build.rs --ignore "/*" --ignore "[a-zA-Z]:/*" --excl-br-line "^\s*((debug_)?assert(_eq|_ne)?!|#\[derive\()"
2020-04-08 19:52:03 +00:00
echo ::set-output name=report::${COVERAGE_REPORT_FILE}
- name : Upload coverage results (to Codecov.io)
uses : codecov/codecov-action@v1
# if: steps.vars.outputs.HAS_CODECOV_TOKEN
with :
# token: ${{ secrets.CODECOV_TOKEN }}
file : ${{ steps.coverage.outputs.report }}
## flags: IntegrationTests, UnitTests, ${{ steps.vars.outputs.CODECOV_FLAGS }}
flags : ${{ steps.vars.outputs.CODECOV_FLAGS }}
name : codecov-umbrella
2020-05-25 20:47:42 +00:00
fail_ci_if_error : false
