More documentation added. #13
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
| permissions: | |
| contents: read | |
| on: | |
| push: | |
| branches: [master] | |
| pull_request: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| name: test | |
| jobs: | |
| required: | |
| runs-on: ubuntu-latest | |
| name: ubuntu / ${{ matrix.toolchain }} | |
| strategy: | |
| matrix: | |
| # run on stable and beta to ensure that tests won't break on the next version of the rust | |
| # toolchain | |
| toolchain: [stable, beta] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install ${{ matrix.toolchain }} | |
| uses: dtolnay/rust-toolchain@master | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| - name: cargo generate-lockfile | |
| # enable this ci template to run regardless of whether the lockfile is checked in or not | |
| if: hashFiles('Cargo.lock') == '' | |
| run: cargo generate-lockfile | |
| # https://twitter.com/jonhoo/status/1571290371124260865 | |
| - name: cargo test --locked | |
| run: cargo test --locked --all-features --all-targets | |
| # https://github.com/rust-lang/cargo/issues/6669 | |
| - name: cargo test --doc | |
| run: cargo test --locked --all-features --doc | |
| coverage: | |
| # use llvm-cov to build and collect coverage and outputs in a format that | |
| # is compatible with codecov.io | |
| # | |
| # note that codecov as of v4 requires that CODECOV_TOKEN from | |
| # | |
| # https://app.codecov.io/gh/<user or org>/<project>/settings | |
| # | |
| # is set in two places on your repo: | |
| # | |
| # - https://github.com/jonhoo/guardian/settings/secrets/actions | |
| # - https://github.com/jonhoo/guardian/settings/secrets/dependabot | |
| # | |
| # (the former is needed for codecov uploads to work with Dependabot PRs) | |
| # | |
| # PRs coming from forks of your repo will not have access to the token, but | |
| # for those, codecov allows uploading coverage reports without a token. | |
| # it's all a little weird and inconvenient. see | |
| # | |
| # https://github.com/codecov/feedback/issues/112 | |
| # | |
| # for lots of more discussion | |
| runs-on: ubuntu-latest | |
| name: ubuntu / stable / coverage | |
| steps: | |
| - uses: actions/checkout@v4 | |
| with: | |
| submodules: true | |
| - name: Install stable | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: llvm-tools-preview | |
| - name: cargo install cargo-llvm-cov | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: cargo generate-lockfile | |
| if: hashFiles('Cargo.lock') == '' | |
| run: cargo generate-lockfile | |
| - name: cargo llvm-cov | |
| run: cargo llvm-cov --locked --all-features --lcov --output-path lcov.info | |
| - name: Record Rust version | |
| run: echo "RUST=$(rustc --version)" >> "$GITHUB_ENV" | |
| - name: Upload to codecov.io | |
| uses: codecov/codecov-action@v4 | |
| with: | |
| fail_ci_if_error: true | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| env_vars: OS,RUST | |