docs: add codecov badge #53
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 | |
| on: | |
| push: | |
| branches: | |
| - dev | |
| - main | |
| tags: | |
| - '*' | |
| pull_request: | |
| workflow_dispatch: | |
| defaults: | |
| run: | |
| shell: bash -leo pipefail {0} | |
| permissions: | |
| contents: 'read' | |
| jobs: | |
| testing: | |
| strategy: | |
| matrix: | |
| os: ["ubuntu-latest", "windows-latest", "macos-latest"] | |
| python-version: ['3.8', '3.9', '3.10', '3.11', '3.12'] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-name: ci | |
| environment-file: environment.yaml | |
| create-args: >- | |
| python==${{ matrix.python-version }} | |
| init-shell: bash | |
| cache-environment: true | |
| post-cleanup: 'all' | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| - name: Build | |
| run: cargo build --release | |
| - name: Rust Tests | |
| run: RUST_BACKTRACE=1 cargo test --release | |
| - name: Build wheels | |
| run: maturin develop --release --manifest-path pyargus/Cargo.toml | |
| - name: Python Tests | |
| run: RUST_BACKTRACE=1 pytest pyargus --hypothesis-explain | |
| linting: | |
| strategy: | |
| matrix: | |
| os: ["ubuntu-latest", "windows-latest", "macos-latest"] | |
| python-version: ['3.10'] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-name: ci | |
| environment-file: environment.yaml | |
| create-args: >- | |
| python==${{ matrix.python-version }} | |
| init-shell: bash | |
| cache-environment: true | |
| post-cleanup: 'all' | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: nightly | |
| components: "clippy, rustfmt" | |
| - name: Rust lints | |
| run: | | |
| cargo +nightly fmt --all --check | |
| cargo +nightly check --workspace | |
| cargo +nightly clippy --workspace | |
| - name: Build Python package | |
| run: maturin develop --release --manifest-path pyargus/Cargo.toml | |
| - name: Python checks | |
| working-directory: pyargus | |
| run: | | |
| black . | |
| isort . | |
| flake8 | |
| ruff check . | |
| mypy . | |
| docs: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-name: ci | |
| environment-file: environment.yaml | |
| init-shell: bash | |
| cache-environment: true | |
| post-cleanup: 'all' | |
| - name: Build Python package | |
| run: maturin develop --release --manifest-path pyargus/Cargo.toml | |
| - name: Build HTML docs | |
| run: | | |
| sphinx-multiversion docs _site -b html | |
| cp ./docs/_templates/index-redirect.html _site/index.html | |
| - name: Deploy | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: github.ref == 'refs/heads/dev' || startsWith(github.ref, 'refs/tags/') | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: _site/ | |
| keep_files: true | |
| coverage: | |
| needs: [linting] | |
| env: | |
| RUSTC_BOOTSTRAP: "1" | |
| CARGO_INCREMENTAL: "0" | |
| RUSTFLAGS: >- | |
| -Zprofile -Ccodegen-units=1 -Copt-level=0 -Clink-dead-code -Coverflow-checks=off -Zpanic_abort_tests -Cpanic=unwind | |
| RUSTDOCFLAGS: "-Cpanic=abort" | |
| LLVM_PROFILE_FILE: "argus-%p-%m.profraw" | |
| strategy: | |
| matrix: | |
| os: ["ubuntu-latest"] | |
| python-version: ["3.10"] | |
| runs-on: ${{ matrix.os }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-name: ci | |
| environment-file: environment.yaml | |
| create-args: >- | |
| python==${{ matrix.python-version }} | |
| init-shell: bash | |
| cache-environment: true | |
| post-cleanup: 'all' | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@nightly | |
| - name: Generate Coverage Reports | |
| run: nox -s coverage | |
| - name: Upload coverage reports to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| files: rust.lcov,python.lcov | |
| env: | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} |