Add project plan #63
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
| name: CI # Continuous Integration | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| jobs: | |
| test: | |
| name: Test Suite | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: 1.79.0 | |
| profile: minimal | |
| override: true | |
| - uses: Swatinem/rust-cache@v2 | |
| - uses: actions-rs/cargo@v1 | |
| with: | |
| command: test | |
| args: --all-features --workspace | |
| rustfmt: | |
| name: Rustfmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: 1.79.0 | |
| profile: minimal | |
| override: true | |
| components: rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Check formatting | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: fmt | |
| args: --all -- --check | |
| clippy: | |
| name: Clippy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: 1.79.0 | |
| profile: minimal | |
| override: true | |
| components: clippy | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Clippy check | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: clippy | |
| args: --all-targets --all-features --workspace -- -D warnings | |
| docs: | |
| name: Docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Install Rust toolchain | |
| uses: actions-rs/toolchain@v1 | |
| with: | |
| toolchain: 1.79.0 | |
| profile: minimal | |
| override: true | |
| - uses: Swatinem/rust-cache@v2 | |
| - name: Check documentation | |
| env: | |
| RUSTDOCFLAGS: -D warnings | |
| uses: actions-rs/cargo@v1 | |
| with: | |
| command: doc | |
| args: --no-deps --document-private-items --all-features --workspace --examples | |
| # publish-dry-run: | |
| # name: Publish dry run | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - name: Checkout repository | |
| # uses: actions/checkout@v4 | |
| # - name: Install Rust toolchain | |
| # uses: actions-rs/toolchain@v1 | |
| # with: | |
| # toolchain: stable | |
| # profile: minimal | |
| # override: true | |
| # - uses: Swatinem/rust-cache@v2 | |
| # - uses: actions-rs/cargo@v1 | |
| # with: | |
| # command: publish | |
| # args: --dry-run | |
| # coverage: | |
| # name: Code coverage | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - name: Checkout repository | |
| # uses: actions/checkout@v4 | |
| # - name: Install Rust toolchain | |
| # uses: actions-rs/toolchain@v1 | |
| # with: | |
| # toolchain: stable | |
| # profile: minimal | |
| # override: true | |
| # - uses: Swatinem/rust-cache@v2 | |
| # - name: Run cargo-tarpaulin | |
| # uses: actions-rs/[email protected] | |
| # with: | |
| # args: '--all-features --workspace --ignore-tests --out Lcov' | |
| # - name: Upload to Coveralls | |
| # # upload only if push | |
| # if: ${{ github.event_name == 'push' }} | |
| # uses: coverallsapp/github-action@master | |
| # with: | |
| # github-token: ${{ secrets.GITHUB_TOKEN }} | |
| # path-to-lcov: './lcov.info' | |