Temporary disable doc tests on stable Rust #78
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: ["main"] | |
| tags: ["v*"] | |
| pull_request: | |
| branches: ["main"] | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| RUST_BACKTRACE: 1 | |
| jobs: | |
| ########################## | |
| # Linting and formatting # | |
| ########################## | |
| clippy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: stable | |
| components: clippy | |
| - run: make cargo.lint | |
| rustfmt: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: nightly | |
| components: rustfmt | |
| - run: make cargo.fmt check=yes | |
| ########### | |
| # Testing # | |
| ########### | |
| msrv: | |
| name: MSRV | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| msrv: ["1.75.0"] | |
| os: ["ubuntu", "macOS", "windows"] | |
| runs-on: ${{ matrix.os }}-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: nightly | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: ${{ matrix.msrv }} | |
| - run: cargo +nightly update -Z minimal-versions | |
| - run: make test.cargo | |
| test: | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| toolchain: ["stable", "beta", "nightly"] | |
| os: ["ubuntu", "macOS", "windows"] | |
| runs-on: ${{ matrix.os }}-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: ${{ matrix.toolchain }} | |
| components: rust-src | |
| - run: cargo install cargo-careful | |
| if: ${{ matrix.toolchain == 'nightly' }} | |
| - run: make test.cargo | |
| careful=${{ (matrix.toolchain == 'nightly' && 'yes') | |
| || 'no' }} | |
| ################# | |
| # Documentation # | |
| ################# | |
| rustdoc: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - run: make cargo.doc private=yes open=no | |
| env: | |
| RUSTFLAGS: -D warnings | |
| ############# | |
| # Releasing # | |
| ############# | |
| publish: | |
| name: publish (crates.io) | |
| if: ${{ startsWith(github.ref, 'refs/tags/v') }} | |
| needs: ["release-github"] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@v1 | |
| with: | |
| toolchain: stable | |
| - run: cargo publish -p tracerr | |
| env: | |
| CARGO_REGISTRY_TOKEN: ${{ secrets.CRATESIO_TOKEN }} | |
| release-github: | |
| name: release (GitHub) | |
| if: ${{ startsWith(github.ref, 'refs/tags/v') }} | |
| needs: ["clippy", "msrv", "rustdoc", "rustfmt", "test"] | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Parse release version | |
| id: release | |
| run: echo "version=${GITHUB_REF#refs/tags/v}" | |
| >> $GITHUB_OUTPUT | |
| - name: Verify release version matches Cargo manifest | |
| run: | | |
| test "${{ steps.release.outputs.version }}" \ | |
| == "$(grep -m1 'version = "' Cargo.toml | cut -d'"' -f2)" | |
| - name: Parse CHANGELOG link | |
| id: changelog | |
| run: echo "link=${{ github.server_url }}/${{ github.repository }}/blob/v${{ steps.release.outputs.version }}/CHANGELOG.md#$(sed -n '/^## \[${{ steps.release.outputs.version }}\]/{s/^## \[\(.*\)\][^0-9]*\([0-9].*\)/\1--\2/;s/[^0-9a-z-]*//g;p;}' CHANGELOG.md)" | |
| >> $GITHUB_OUTPUT | |
| - name: Create GitHub release | |
| uses: softprops/action-gh-release@v2 | |
| with: | |
| name: ${{ steps.release.outputs.version }} | |
| body: | | |
| [API docs](https://docs.rs/tracerr/${{ steps.release.outputs.version }}) | |
| [Changelog](${{ steps.changelog.outputs.link }}) | |
| prerelease: ${{ contains(steps.release.outputs.version, '-') }} |