feat[#7]: update ci workflow to build and test #36
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
name: CI | |
on: | |
pull_request: | |
env: | |
CARGO_INCREMENTAL: 0 | |
CARGO_NET_RETRY: 10 | |
RUST_BACKTRACE: short | |
RUSTFLAGS: "-D warnings" | |
RUSTUP_MAX_RETRIES: 10 | |
MACOSX_DEPLOYMENT_TARGET: 10.7 | |
jobs: | |
# Run the `rustfmt` code formatter | |
rustfmt: | |
name: Rustfmt [Formatter] | |
runs-on: ubuntu-latest | |
steps: | |
- name: Setup | Checkout | |
uses: actions/checkout@v4 | |
- name: Setup | Rust | |
uses: dtolnay/rust-toolchain@stable | |
with: | |
components: rustfmt | |
- name: Build | Format | |
run: cargo fmt --all -- --check | |
# Run the `clippy` linting tool | |
clippy: | |
name: Clippy [Linter] | |
strategy: | |
matrix: | |
os: [ubuntu-latest, macOS-latest, windows-latest] | |
runs-on: ${{ matrix.os }} | |
steps: | |
- name: Setup | Checkout | |
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
- name: Setup | Rust | |
uses: dtolnay/rust-toolchain@stable | |
with: | |
components: clippy | |
- name: Setup | Cache | |
uses: Swatinem/rust-cache@v2 | |
- name: Build | Lint | |
uses: giraffate/clippy-action@94e9bd8deab2618756ec5380f12eb35bcb0a88ca | |
# Ensure that the project could be successfully compiled | |
cargo_check: | |
name: Compile | |
runs-on: ubuntu-latest | |
steps: | |
- name: Setup | Checkout | |
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4 | |
- name: Setup | Rust | |
uses: dtolnay/rust-toolchain@stable | |
- name: Setup | Cache | |
uses: Swatinem/rust-cache@v2 | |
- name: Build | Check | |
run: cargo check --workspace --locked | |
# Ensure that the project could be successfully compiled with no features enabled | |
cargo_check_no_features: | |
name: Compile with no features enabled | |
needs: cargo_check | |
runs-on: ubuntu-latest | |
steps: | |
- name: Setup | Checkout | |
uses: actions/checkout@v4 | |
- name: Setup | Rust | |
uses: dtolnay/rust-toolchain@stable | |
- name: Setup | Cache | |
uses: Swatinem/rust-cache@v2 | |
- name: Build | Check | |
run: cargo check --workspace --locked --no-default-features | |
# Ensure that the project could be successfully compiled with all features enabled | |
cargo_check_all_features: | |
name: Compile with all features enabled | |
needs: cargo_check | |
runs-on: ubuntu-latest | |
steps: | |
- name: Setup | Checkout | |
uses: actions/checkout@v4 | |
- name: Setup | Rust | |
uses: dtolnay/rust-toolchain@stable | |
- name: Setup | Cache | |
uses: Swatinem/rust-cache@v2 | |
- name: Build | Check | |
run: cargo check --workspace --locked --all-features | |
# Run tests on Linux, macOS, and Windows | |
# On both Rust stable and Rust nightly | |
test: | |
name: Test Suite | |
runs-on: ${{ matrix.os }} | |
needs: cargo_check # First check then run expansive tests | |
strategy: | |
fail-fast: false | |
matrix: | |
os: [ubuntu-latest, macOS-latest, windows-latest] | |
rust: [stable, nightly] | |
include: | |
- os: windows-latest | |
rustflags: -C target-feature=+crt-static | |
env: | |
RUSTFLAGS: ${{ matrix.rustflags || '' }} | |
steps: | |
- name: Setup | Checkout | |
uses: actions/checkout@v4 | |
# Install all the required dependencies for testing | |
- name: Setup | Rust | |
uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: ${{ matrix.rust }} | |
components: llvm-tools-preview | |
- name: Setup | Cache | |
uses: Swatinem/rust-cache@v2 | |
- name: Install cargo-llvm-cov | |
uses: taiki-e/install-action@cargo-llvm-cov | |
# # For windows installer test | |
# # On stable rust & main repo pushes only | |
# - name: Install cargo-wix [Windows] | |
# continue-on-error: true | |
# if: matrix.os == 'windows-latest' && matrix.rust == 'stable' | |
# run: cargo install --version 0.3.4 cargo-wix | |
# env: | |
# # cargo-wix does not require static crt | |
# RUSTFLAGS: "" | |
# # Install Mercurial (pre-installed on Linux and windows) | |
# - name: Setup | Mercurial (macos) | |
# if: matrix.os == 'macOS-latest' | |
# run: brew install mercurial | |
# Run the ignored tests that expect the above setup | |
- name: Build | Test | |
run: "cargo llvm-cov | |
--all-features | |
--locked | |
--workspace | |
--lcov --output-path lcov.info | |
-- --include-ignored" | |
env: | |
# Avoid -D warnings on nightly builds | |
RUSTFLAGS: "" | |
# - name: Build | Installer [Windows] | |
# continue-on-error: true | |
# if: matrix.os == 'windows-latest' && matrix.rust == 'stable' | |
# run: cargo wix --dbg-build -v --nocapture -I install/windows/main.wxs | |
# - name: Build | Chocolatey Package [Windows] | |
# continue-on-error: true | |
# if: matrix.os == 'windows-latest' && matrix.rust == 'stable' | |
# run: | | |
# # Setup dummy release artifacts | |
# foreach ($arch in @("aarch64", "i686", "x86_64")) { | |
# foreach ($ext in @("zip", "msi")) { | |
# New-Item -ItemType Directory -Path ./orbiter-$arch-pc-windows-msvc.$ext | |
# New-Item -ItemType File -Path ./orbiter-$arch-pc-windows-msvc.$ext/orbiter-$arch-pc-windows-msvc.$ext | |
# } | |
# } | |
# # Build package | |
# pwsh ./install/windows/choco/update.ps1 | |
# env: | |
# ORBITER_VERSION: v0.5.0 | |
- name: Upload coverage to Codecov | |
uses: codecov/codecov-action@v4 | |
if: github.repository == 'orbiter-rs/orbiter' | |
with: | |
token: ${{ secrets.CODECOV_TOKEN }} | |
files: lcov.info |