Merge pull request #2 from is-it-ayush/ayu/tiny_readme_update #6
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
# Thanks @jonhoo! https://github.com/jonhoo/rust-ci-conf | |
# This workflow runs whenever a PR is opened or updated, or a commit is pushed to main. It runs | |
# several checks: | |
# - fmt: checks that the code is formatted according to rustfmt | |
# - clippy: checks that the code does not contain any clippy warnings | |
# - doc: checks that the code can be documented without errors | |
permissions: | |
contents: read | |
on: | |
push: | |
branches: [master] | |
pull_request: | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} | |
cancel-in-progress: true | |
name: check | |
jobs: | |
miri: | |
runs-on: ubuntu-latest | |
name: stable / miri | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- run: | | |
echo "NIGHTLY=nightly-$(curl -s https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/miri)" >> $GITHUB_ENV | |
- name: Install ${{ env.NIGHTLY }} | |
uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: ${{ env.NIGHTLY }} | |
components: miri | |
- name: cargo miri test | |
run: cargo miri test | |
env: | |
MIRIFLAGS: "" | |
build: | |
runs-on: ubuntu-latest | |
name: stable / build | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Install stable | |
uses: dtolnay/rust-toolchain@stable | |
with: | |
components: rustfmt | |
- name: cargo build | |
run: cargo test | |
test: | |
runs-on: ubuntu-latest | |
name: stable / test | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Install stable | |
uses: dtolnay/rust-toolchain@stable | |
with: | |
components: rustfmt | |
- name: cargo test | |
run: cargo test | |
fmt: | |
runs-on: ubuntu-latest | |
name: stable / fmt | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Install stable | |
uses: dtolnay/rust-toolchain@stable | |
with: | |
components: rustfmt | |
- name: cargo fmt --check | |
run: cargo fmt --check | |
clippy: | |
runs-on: ubuntu-latest | |
name: ${{ matrix.toolchain }} / clippy | |
permissions: | |
contents: read | |
checks: write | |
strategy: | |
fail-fast: false | |
matrix: | |
# Get early warning of new lints which are regularly introduced in beta channels. | |
toolchain: [stable, beta] | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Install ${{ matrix.toolchain }} | |
uses: dtolnay/rust-toolchain@master | |
with: | |
toolchain: ${{ matrix.toolchain }} | |
components: clippy | |
- name: cargo clippy | |
uses: giraffate/clippy-action@v1 | |
with: | |
reporter: 'github-pr-check' | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
doc: | |
# run docs generation on nightly rather than stable. This enables features like | |
# https://doc.rust-lang.org/beta/unstable-book/language-features/doc-cfg.html which allows an | |
# API be documented as only available in some specific platforms. | |
runs-on: ubuntu-latest | |
name: nightly / doc | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
submodules: true | |
- name: Install nightly | |
uses: dtolnay/rust-toolchain@nightly | |
- name: cargo doc | |
run: cargo doc --no-deps --all-features | |
env: | |
RUSTDOCFLAGS: --cfg docsrs |