README: update docs to include more modern info #16
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
| # libpathrs: safe path resolution on Linux | |
| # Copyright (C) 2019-2024 Aleksa Sarai <[email protected]> | |
| # Copyright (C) 2019-2024 SUSE LLC | |
| # | |
| # This program is free software: you can redistribute it and/or modify it under | |
| # the terms of the GNU Lesser General Public License as published by the Free | |
| # Software Foundation, either version 3 of the License, or (at your option) any | |
| # later version. | |
| # | |
| # This program is distributed in the hope that it will be useful, but WITHOUT ANY | |
| # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A | |
| # PARTICULAR PURPOSE. See the GNU General Public License for more details. | |
| # | |
| # You should have received a copy of the GNU Lesser General Public License along | |
| # with this program. If not, see <https://www.gnu.org/licenses/>. | |
| on: | |
| push: | |
| branches: [ main ] | |
| pull_request: | |
| branches: [ main ] | |
| release: | |
| types: [ published ] | |
| schedule: | |
| - cron: '0 0 * * *' | |
| name: rust-ci | |
| jobs: | |
| check: | |
| name: cargo check | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo check --workspace --all-features --all-targets | |
| rustdoc: | |
| name: cargo doc | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo doc --workspace --all-features | |
| - name: upload docs | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: rustdoc | |
| path: target/doc | |
| test: | |
| name: cargo test | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Nightly rust is required for llvm-cov --doc. | |
| - uses: dtolnay/rust-toolchain@nightly | |
| - uses: taiki-e/install-action@cargo-llvm-cov | |
| - uses: taiki-e/install-action@nextest | |
| # Rust tests. | |
| - name: rust doc tests | |
| run: make CARGO_NIGHTLY=cargo test-rust-doctest | |
| - name: rust unit tests | |
| run: make CARGO_NIGHTLY=cargo test-rust-unpriv | |
| - name: rust unit tests (root) | |
| run: make CARGO_NIGHTLY=cargo test-rust-root | |
| - name: calculate coverage | |
| run: cargo llvm-cov report | |
| - name: generate coverage html | |
| run: cargo llvm-cov report --html | |
| - name: upload coverage html | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: coverage-report | |
| path: target/llvm-cov/html | |
| examples: | |
| name: smoke-test examples | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - run: cargo build --examples | |
| - run: make -C examples smoke-test-rust | |
| fmt: | |
| name: rustfmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: rustup toolchain install stable | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt | |
| - run: cargo fmt --all -- --check | |
| clippy: | |
| name: clippy | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - run: rustup toolchain install stable | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: clippy | |
| - run: cargo clippy --all-features --all-targets |