name: CI
permissions:
contents: read
on:
pull_request:
branches:
- main
push:
branches:
- main
tags:
- v*
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
jobs:
single-commit:
name: Enforce single commit
runs-on: ubuntu-latest
steps:
- name: Enforce exactly one commit for a PR
if: github.event_name == 'pull_request'
run: |
COUNT="${{ github.event.pull_request.commits }}"
echo "PR contains $COUNT commit(s)"
if [ "$COUNT" -ne 1 ]; then
echo "::error::PRs must contain exactly one commit. Squash locally (git rebase -i) and force-push."
exit 1
fi
toolchain:
name: Setup Rust toolchain
runs-on: ubuntu-latest
needs: single-commit
outputs:
stable: ${{ steps.set_toolchain.outputs.stable }}
nightly: ${{ steps.set_toolchain.outputs.nightly }}
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
- name: Output toolchain
id: set_toolchain
run: |
stable=$(grep channel rust-toolchain.toml | sed -r 's/channel = "(.*)"/\1/')
echo "stable=$stable" | tee -a "$GITHUB_OUTPUT"
nightly=$(rustc --version | grep -oE '[0-9]{4}-[0-9]{2}-[0-9]{2}' | sed 's/^/nightly-/')
echo "nightly=$nightly" | tee -a "$GITHUB_OUTPUT"
fmt-check:
name: Check Code Format
runs-on: ubuntu-latest
needs: toolchain
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
- name: Install Rust
uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 with:
toolchain: ${{ needs.toolchain.outputs.nightly }}
components: rustfmt
- name: Install just
uses: taiki-e/install-action@cfdb7ed4ccc7c7dce37759eae89dc5674b469b39 with:
tool: just
- name: Setup Rust cache
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0
- name: just fmt-check
run: |
just fmt-check
lint:
name: Lint Code
runs-on: ubuntu-latest
needs: toolchain
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
- name: Install Rust
uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 with:
toolchain: ${{ needs.toolchain.outputs.stable }}
components: clippy
- name: Install just
uses: taiki-e/install-action@cfdb7ed4ccc7c7dce37759eae89dc5674b469b39 with:
tool: just
- name: Setup Rust cache
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0
- name: just lint
run: |
rustup override set ${{ needs.toolchain.outputs.stable }}
just lint
test:
name: Run Tests
runs-on: ubuntu-latest
needs: toolchain
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
- name: Install Rust
uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 with:
toolchain: ${{ needs.toolchain.outputs.stable }}
- name: Install just
uses: taiki-e/install-action@cfdb7ed4ccc7c7dce37759eae89dc5674b469b39 with:
tool: just
- name: Setup Rust cache
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0
- name: just test
run: |
rustup override set ${{ needs.toolchain.outputs.stable }}
just test
doc:
name: Create Documentation
runs-on: ubuntu-latest
needs: toolchain
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1
- name: Install Rust
uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 with:
toolchain: ${{ needs.toolchain.outputs.stable }}
components: rust-docs
- name: Install just
uses: taiki-e/install-action@cfdb7ed4ccc7c7dce37759eae89dc5674b469b39 with:
tool: just
- name: Setup Rust cache
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0
- name: just doc
run: |
rustup override set ${{ needs.toolchain.outputs.stable }}
just doc
public-deps:
name: Check Public Dependencies
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
needs: toolchain
permissions:
contents: read
outputs:
finding: ${{ steps.check.outputs.finding }}
head-sha: ${{ steps.check.outputs.head-sha }}
steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 with:
fetch-depth: 0
- name: Install Rust
uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 with:
toolchain: ${{ needs.toolchain.outputs.nightly }}
- name: Setup Rust cache
uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0
- name: Check public dependencies
id: check
uses: hseeberger/public-deps-check@d21137be3f97b6c6d9ecc18f879f05ca3fbcc2f0 with:
command: analyze
base-sha: ${{ github.event.pull_request.base.sha }}
head-sha: ${{ github.event.pull_request.head.sha }}
toolchain: ${{ needs.toolchain.outputs.nightly }}
public-deps-mark:
name: Mark Breaking Dependency Update
if: >-
${{ !cancelled()
&& needs.public-deps.outputs.finding == 'missing-marker'
&& github.event.pull_request.user.login == 'dependabot[bot]' }}
runs-on: ubuntu-latest
needs: public-deps
permissions: {}
steps:
- name: Generate a token
id: app-token
uses: actions/create-github-app-token@64ab729a6294000f5aa4a4bc0b73d1f32bc45510 with:
app-id: ${{ secrets.APP_ID }}
private-key: ${{ secrets.APP_PRIVATE_KEY }}
- name: Add ! to the commit subject
uses: hseeberger/public-deps-check@d21137be3f97b6c6d9ecc18f879f05ca3fbcc2f0 with:
command: mark
head-sha: ${{ needs.public-deps.outputs.head-sha }}
pr-number: ${{ github.event.pull_request.number }}
token: ${{ steps.app-token.outputs.token }}