Checks Rust code on push #115
Workflow file for this run
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 - Code Checks & Tests | |
| run-name: Checks Rust code on ${{ github.event_name }} | |
| on: | |
| push: | |
| paths: | |
| - ".github/workflows/build.yml" | |
| - "Cargo.*" | |
| - "src/**" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/build.yml" | |
| - "Cargo.*" | |
| - "src/**" | |
| env: | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| ci_code_checks_ans_tests: | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| name: Code Checks and Tests | |
| steps: | |
| - name: "Install rust-toolchain stable" | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: clippy, rustfmt | |
| - name: "Show environment" | |
| run: | | |
| rustc -vV | |
| cargo -vV | |
| - name: "Checkout" | |
| uses: actions/checkout@v4 | |
| - name: Install cargo-readme | |
| run: cargo install cargo-readme | |
| - name: Install cargo-spellcheck | |
| run: cargo install cargo-spellcheck | |
| - name: Check if readme is up to date | |
| id: cargo_readme | |
| if: $${{ always() }} | |
| run: diff README.md <(cargo readme) | |
| - name: "Cargo clippy" | |
| id: cargo_clippy | |
| if: $${{ always() }} | |
| run: | | |
| cargo clippy --profile=test | |
| - name: "Cargo test" | |
| id: cargo_test | |
| if: $${{ always() }} | |
| run: | | |
| cargo test | |
| - name: "Cargo formatting" | |
| id: cargo_fmt | |
| if: $${{ always() }} | |
| run: | | |
| cargo fmt --all -- --check | |
| - name: "Cargo doc" | |
| id: cargo_doc | |
| env: | |
| RUSTDOCFLAGS: "-D warnings" | |
| if: $${{ always() }} | |
| run: | | |
| cargo doc | |
| - name: Check for spelling errors in docs | |
| id: cargo_spellcheck | |
| if: $${{ always() }} | |
| run: | | |
| cargo spellcheck | |
| - name: "Some checks failed" | |
| if: ${{ failure() }} | |
| run: | | |
| echo "### :x: Checks Failed!" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "|Job|Status|" >> $GITHUB_STEP_SUMMARY | |
| echo "|---|------|" >> $GITHUB_STEP_SUMMARY | |
| echo "|Cargo readme|${{ steps.cargo_readme.outcome }}|" >> $GITHUB_STEP_SUMMARY | |
| echo "|Cargo clippy|${{ steps.cargo_clippy.outcome }}|" >> $GITHUB_STEP_SUMMARY | |
| echo "|Cargo test|${{ steps.cargo_test.outcome }}|" >> $GITHUB_STEP_SUMMARY | |
| echo "|Cargo fmt|${{ steps.cargo_fmt.outcome }}|" >> $GITHUB_STEP_SUMMARY | |
| echo "|Cargo doc|${{ steps.cargo_doc.outcome }}|" >> $GITHUB_STEP_SUMMARY | |
| echo "|Cargo spellcheck|${{ steps.cargo_spellcheck.outcome }}|" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| echo "Please check the failed jobs and fix where needed." >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY | |
| exit 1 | |
| - name: "All checks passed" | |
| if: ${{ success() }} | |
| run: | | |
| echo "### :white_check_mark: Checks Passed!" >> $GITHUB_STEP_SUMMARY | |
| echo "" >> $GITHUB_STEP_SUMMARY |