Skip to content

Commit

Permalink
ci: set up GitHub Actions for CI and CD
Browse files Browse the repository at this point in the history
- Add CD workflow for creating releases on tag push
- Add CI workflow for running clippy, formatting, docs, and tests
- Update test workflow to use the same codecov action as other workflows
  • Loading branch information
ShenMian committed Jan 21, 2025
1 parent 08740f2 commit 08e07d4
Show file tree
Hide file tree
Showing 3 changed files with 192 additions and 1 deletion.
66 changes: 66 additions & 0 deletions .github/workflows/cd.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: CD

on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+'

permissions:
contents: write

env:
CARGO_TERM_COLOR: always
RUSTFLAGS: --deny warnings
RUSTDOCFLAGS: --deny warnings

jobs:
release:
name: Release
strategy:
matrix:
include:
- os: ubuntu-latest
artifact_name: tracker
asset_name: tracker-linux-x86_64
target: x86_64-unknown-linux-gnu
- os: windows-latest
artifact_name: tracker.exe
asset_name: tracker-windows-x86_64
target: x86_64-pc-windows-msvc
- os: macos-latest
artifact_name: tracker
asset_name: tracker-macos-x86_64
target: x86_64-apple-darwin
- os: macos-latest
artifact_name: tracker
asset_name: tracker-macos-aarch64
target: aarch64-apple-darwin
runs-on: ${{ matrix.os }}

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
targets: ${{ matrix.target }}

- name: Build
run: cargo build --release --target ${{ matrix.target }}

- name: Create archive
shell: bash
run: |
cd target/${{ matrix.target }}/release
if [ "${{ matrix.os }}" = "windows-latest" ]; then
7z a -tzip ${{ matrix.asset_name }}.zip ${{ matrix.artifact_name }}
else
tar -czf ${{ matrix.asset_name }}.tar.gz ${{ matrix.artifact_name }}
fi
- name: Create release and upload assets
uses: softprops/action-gh-release@v2
with:
files: |
target/${{ matrix.target }}/release/${{ matrix.asset_name }}.*
125 changes: 125 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
name: CI

on: [pull_request, push]

env:
CARGO_TERM_COLOR: always
RUSTFLAGS: --deny warnings
RUSTDOCFLAGS: --deny warnings

jobs:
clippy:
name: Clippy
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Cache Cargo artifacts
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: cargo-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Run clippy lints
run: cargo clippy --locked --workspace --all-targets --all-features -- --deny warnings

format:
name: Format
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Cache Cargo artifacts
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: cargo-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt

- name: Run cargo fmt
run: cargo fmt --all -- --check

doc:
name: Docs
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Cache Cargo artifacts
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: cargo-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Check documentation
run: cargo doc --locked --workspace --all-features --document-private-items --no-deps

test:
name: Tests
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Cache Cargo artifacts
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: cargo-${{ runner.os }}-${{ hashFiles('**/Cargo.lock') }}

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Install alsa and udev
run: sudo apt-get update; sudo apt-get install --no-install-recommends libasound2-dev libudev-dev
if: runner.os == 'linux'

- name: Run tests
run: |
cargo test --locked --workspace --all-features --all-targets
# Workaround for https://github.com/rust-lang/cargo/issues/6669
cargo test --locked --workspace --all-features --doc
- name: Generate code coverage
run: cargo llvm-cov --all-features --no-cfg-coverage --workspace --lcov --output-path lcov.info

- name: Upload coverage to Codecov
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: lcov.info
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ jobs:
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: lcov.info
files: lcov.info

0 comments on commit 08e07d4

Please sign in to comment.