-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Github Actions CI jobs for testing, linting, formatting etc
- Loading branch information
Showing
5 changed files
with
181 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
name: Build and test | ||
on: | ||
pull_request: | ||
paths: | ||
- .github/workflows/build-and-test.yml | ||
- '**/*.rs' | ||
- Cargo.toml | ||
- Cargo.lock | ||
workflow_dispatch: | ||
|
||
env: | ||
CARGO_TERM_COLOR: always | ||
RUSTFLAGS: --deny warnings | ||
|
||
jobs: | ||
build-and-test: | ||
strategy: | ||
matrix: | ||
os: [ubuntu-latest, macos-latest, windows-latest] | ||
# Keep MSRV in sync with rust-version in Cargo.toml | ||
rust: [stable, beta, nightly, 1.79.0] | ||
runs-on: ${{ matrix.os }} | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af #v1.0.7 | ||
with: | ||
toolchain: ${{ matrix.rust }} | ||
profile: minimal | ||
default: true | ||
|
||
- name: Build | ||
run: cargo build --all-targets --locked | ||
|
||
- name: Test | ||
run: cargo test --locked | ||
|
||
# Make sure documentation builds without warnings (broken links etc) | ||
- name: Generate documentation | ||
if: matrix.rust == 'stable' | ||
run: RUSTDOCFLAGS="--deny warnings" cargo doc | ||
|
||
# Make sure the library builds with all dependencies downgraded to their | ||
# oldest versions allowed by the semver spec. This ensures we have not | ||
# under-specified any dependency | ||
minimal-versions: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- name: Install stable Rust | ||
uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af #v1.0.7 | ||
with: | ||
toolchain: stable | ||
profile: minimal | ||
|
||
- name: Install nightly Rust | ||
uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af #v1.0.7 | ||
with: | ||
toolchain: nightly | ||
profile: minimal | ||
|
||
- name: Downgrade dependencies to minimal versions | ||
run: cargo +nightly update -Z minimal-versions | ||
|
||
- name: Compile with minimal versions | ||
run: cargo +stable build --all-targets --locked |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
--- | ||
name: Audit dependencies | ||
on: | ||
pull_request: | ||
paths: | ||
- .github/workflows/cargo-audit.yml | ||
- Cargo.toml | ||
- Cargo.lock | ||
schedule: | ||
# At 06:20 UTC every day. Will create an issue if a CVE is found. | ||
- cron: '20 6 * * *' | ||
workflow_dispatch: | ||
|
||
jobs: | ||
audit: | ||
runs-on: ubuntu-latest | ||
permissions: | ||
issues: write | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: actions-rust-lang/audit@160ac8b6edd32f74656cabba9d1de3fc8339f676 # v1.2 | ||
name: Audit Rust Dependencies | ||
with: | ||
denyWarnings: true | ||
# Ignored audit issues. This list should be kept short, and effort should be | ||
# put into removing items from the list. | ||
ignore: |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Rust formatting | ||
on: | ||
pull_request: | ||
paths: | ||
- .github/workflows/formatting.yml | ||
- '**/*.rs' | ||
workflow_dispatch: | ||
jobs: | ||
check-formatting: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: actions-rs/toolchain@16499b5e05bf2e26879000db0c1d13f7e13fa3af #v1.0.7 | ||
with: | ||
toolchain: stable | ||
profile: minimal | ||
components: rustfmt | ||
default: true | ||
|
||
- name: Check formatting | ||
run: | | ||
rustfmt --version | ||
cargo fmt -- --check |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
name: Git - Check commit message style | ||
on: | ||
push: | ||
workflow_dispatch: | ||
|
||
jobs: | ||
check-commit-message-style: | ||
name: Check commit message style | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Make sure there are no whitespaces other than space, tab and newline in a commit message. | ||
- name: Check for unicode whitespaces | ||
uses: gsactions/commit-message-checker@16fa2d5de096ae0d35626443bcd24f1e756cafee #v2.0.0 | ||
with: | ||
# Pattern matches strings not containing weird unicode whitespace/separator characters | ||
# \P{Z} = All non-whitespace characters (the u-flag is needed to enable \P{Z}) | ||
# [ \t\n] = Allowed whitespace characters | ||
pattern: '^(\P{Z}|[ \t\n])+$' | ||
flags: 'u' | ||
error: 'Detected unicode whitespace character in commit message.' | ||
checkAllCommitMessages: 'true' # optional: this checks all commits associated with a pull request | ||
accessToken: ${{ secrets.GITHUB_TOKEN }} # only required if checkAllCommitMessages is true | ||
|
||
# Git commit messages should follow these guidelines: https://cbea.ms/git-commit/ | ||
- name: Check against guidelines | ||
uses: mristin/opinionated-commit-message@f3b9cec249cabffbae7cd564542fd302cc576827 #v3.1.1 | ||
with: | ||
# Commit messages are allowed to be subject only, no body | ||
allow-one-liners: 'true' | ||
# This action defaults to 50 char subjects, but 72 is fine. | ||
max-subject-line-length: '72' |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Rust linting | ||
on: | ||
pull_request: | ||
paths: | ||
- .github/workflows/linting.yml | ||
- '**/*.rs' | ||
- Cargo.toml | ||
- Cargo.lock | ||
workflow_dispatch: | ||
jobs: | ||
clippy-linting: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v4 | ||
|
||
- uses: actions-rs/[email protected] | ||
with: | ||
toolchain: stable | ||
profile: minimal | ||
components: clippy | ||
default: true | ||
|
||
- name: Clippy check | ||
env: | ||
RUSTFLAGS: --deny warnings | ||
run: cargo clippy --locked --all-targets |