Skip to content

CI

CI #408

Workflow file for this run

# SPDX-FileCopyrightText: 2022 Shun Sakai
#
# SPDX-License-Identifier: Apache-2.0 OR MIT
name: CI
on:
pull_request:
push:
branches:
- "develop"
- "master"
schedule:
- cron: "0 0 * * 0"
jobs:
package-test:
name: Package Test
runs-on: ${{ matrix.os }}
strategy:
matrix:
target:
- x86_64-unknown-linux-gnu
- x86_64-apple-darwin
- x86_64-pc-windows-msvc
toolchain:
- 1.70.0 # MSRV
- stable
crate:
- abcrypt
- abcrypt-cli
- abcrypt-capi
include:
- target: x86_64-unknown-linux-gnu
os: ubuntu-22.04
- target: x86_64-apple-darwin
os: macos-12
- target: x86_64-pc-windows-msvc
os: windows-2022
steps:
- name: Set Git to use LF
if: matrix.os == 'windows-2022'
run: |
git config --global core.autocrlf false
git config --global core.eol lf
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
toolchain: ${{ matrix.toolchain }}
targets: ${{ matrix.target }}
- name: Cache build artifacts
uses: Swatinem/[email protected]
with:
key: ${{ matrix.target }}
- name: Run tests
run: cargo test -p ${{ matrix.crate }} --target ${{ matrix.target }}
- name: Run tests (no default features)
if: matrix.crate != 'abcrypt-capi'
run: cargo test -p ${{ matrix.crate }} --target ${{ matrix.target }} --no-default-features
- name: Run tests (`alloc` feature)
if: matrix.crate == 'abcrypt'
run: cargo test -p ${{ matrix.crate }} --target ${{ matrix.target }} --no-default-features -F alloc
- name: Run tests (`serde` feature)
if: matrix.crate == 'abcrypt'
run: cargo test -p ${{ matrix.crate }} --target ${{ matrix.target }} -F serde
- name: Run tests (`serde` feature with no default features)
if: matrix.crate == 'abcrypt'
run: cargo test -p ${{ matrix.crate }} --target ${{ matrix.target }} --no-default-features -F serde
- name: Check if the header file is up-to-date
if: matrix.crate == 'abcrypt-capi'
run: git diff --exit-code
workspace-test:
name: Workspace Test
runs-on: ${{ matrix.os }}
strategy:
matrix:
target:
- x86_64-unknown-linux-gnu
- x86_64-apple-darwin
- x86_64-pc-windows-msvc
toolchain:
- 1.70.0 # MSRV
- stable
include:
- target: x86_64-unknown-linux-gnu
os: ubuntu-22.04
- target: x86_64-apple-darwin
os: macos-12
- target: x86_64-pc-windows-msvc
os: windows-2022
steps:
- name: Set Git to use LF
if: matrix.os == 'windows-2022'
run: |
git config --global core.autocrlf false
git config --global core.eol lf
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
toolchain: ${{ matrix.toolchain }}
targets: ${{ matrix.target }}
- name: Cache build artifacts
uses: Swatinem/[email protected]
with:
key: ${{ matrix.target }}
- name: Run tests
run: cargo test --target ${{ matrix.target }}
- name: Run tests (no default features)
run: cargo test --target ${{ matrix.target }} --no-default-features
rustfmt:
name: Rustfmt
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
toolchain: stable
components: rustfmt
- name: Cache build artifacts
uses: Swatinem/[email protected]
- name: Check code formatted
run: cargo fmt --all -- --check
clippy:
name: Clippy
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
toolchain: stable
components: clippy
- name: Cache build artifacts
uses: Swatinem/[email protected]
- name: Check no lint warnings
run: cargo clippy --workspace -- -D warnings
- name: Check no lint warnings (no default features)
run: cargo clippy --workspace --no-default-features -- -D warnings
doc:
name: Documentation
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
toolchain: stable
- name: Cache build artifacts
uses: Swatinem/[email protected]
- name: Check no `rustdoc` lint warnings
run: RUSTDOCFLAGS="-D warnings" cargo doc --workspace --exclude abcrypt-cli --no-deps --document-private-items
benchmark:
name: Benchmark
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
toolchain: nightly
- name: Cache build artifacts
uses: Swatinem/[email protected]
- name: Run benchmarks
run: cargo bench -p abcrypt
capi-examples:
name: Examples for the C API
runs-on: ubuntu-22.04
strategy:
matrix:
toolchain:
- 1.70.0 # MSRV
- stable
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup Rust toolchain
uses: dtolnay/rust-toolchain@v1
with:
toolchain: ${{ matrix.toolchain }}
- name: Install dependencies
run: |
sudo apt-get update
sudo apt-get install libfmt-dev meson
meson -v
- name: Setup just
uses: extractions/setup-just@v1
- name: Cache build artifacts
uses: Swatinem/[email protected]
- name: Build examples for the C API
run: just build-capi-examples
semver:
name: Semantic Versioning
runs-on: ubuntu-22.04
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Check Semantic Versioning
uses: obi1kenobi/[email protected]