Skip to content

Commit

Permalink
ci(ci): added preliminary ci.yml with ftm clippy docs
Browse files Browse the repository at this point in the history
Signed-off-by: gacallea <3269984+gacallea@users.noreply.github.com>
  • Loading branch information
andreacfromtheapp committed Aug 11, 2024
1 parent 577c630 commit 39b83eb
Show file tree
Hide file tree
Showing 2 changed files with 104 additions and 1 deletion.
102 changes: 102 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
name: CI # Continuous Integration

on:
push:
branches:
- main
paths-ignore:
- "**.md"
pull_request:
paths-ignore:
- "**.md"

jobs:
# test:
# name: Test Suite
# runs-on: ubuntu-22.04
# steps:
# - name: Checkout repository
# uses: actions/checkout@v4
# - name: Install cargo-semver-checks
# uses: taiki-e/install-action@v2
# with:
# tool: cargo-semver-checks@0.33
# - name: Start containers
# run: docker compose up -d --wait
# working-directory: ./tests
# - name: Install Rust toolchain
# uses: dtolnay/rust-toolchain@stable
# - uses: Swatinem/rust-cache@v2
# - name: Run tests
# run: cargo test --all-features --workspace
#
# test-no-docker:
# name: Test Suite (no Docker)
# strategy:
# matrix:
# include:
# - target: aarch64-pc-windows-msvc
# os: windows-2022
# - 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
# - target: x86_64-apple-darwin
# os: macos-12
# runs-on: ${{ matrix.os }}
# steps:
# - name: Checkout repository
# uses: actions/checkout@v4
# - name: Install cargo-semver-checks
# uses: taiki-e/install-action@v2
# with:
# tool: cargo-semver-checks@0.33
# - name: Install Rust toolchain
# uses: dtolnay/rust-toolchain@stable
# - uses: Swatinem/rust-cache@v2
# - name: Run tests
# run: cargo test --no-default-features --features all-static --workspace

rustfmt:
name: Rustfmt
runs-on: ubuntu-22.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: rustfmt
- uses: Swatinem/rust-cache@v2
- name: Check formatting
run: cargo fmt --all --check

clippy:
name: Clippy
runs-on: ubuntu-22.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: clippy
- uses: Swatinem/rust-cache@v2
- name: Clippy check
run: cargo clippy --all-targets --all-features --workspace

docs:
name: Docs
runs-on: ubuntu-22.04
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
- uses: Swatinem/rust-cache@v2
- name: Check documentation
env:
RUSTDOCFLAGS: -D warnings
run: cargo doc --no-deps --document-private-items --all-features --workspace --examples
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ samples for a given project more easily.
Assist](https://github.com/gacallea/freesound-credits/actions/workflows/cargo-assist.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/cargo-assist.yml)
[![Cargo
Deny](https://github.com/gacallea/freesound-credits/actions/workflows/cargo-deny.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/cargo-deny.yml)
[![Deployment](https://github.com/gacallea/freesound-credits/actions/workflows/release-plz.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/release-plz.yml)
[![CI](https://github.com/gacallea/freesound-credits/actions/workflows/ci.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/ci.yml)
[![CD](https://github.com/gacallea/freesound-credits/actions/workflows/release-plz.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/release-plz.yml)
[![Release](https://github.com/gacallea/freesound-credits/actions/workflows/release.yml/badge.svg)](https://github.com/gacallea/freesound-credits/actions/workflows/release.yml)
[![Crates.io](https://img.shields.io/crates/v/freesound%2Dcredits.svg)](https://crates.io/crates/freesound-credits)

Expand Down

0 comments on commit 39b83eb

Please sign in to comment.