Add github action to catch badly formated docs #82
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
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| name: CI | |
| jobs: | |
| clippy: | |
| name: Clippy | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| rust: | |
| - stable | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: ${{ matrix.rust }} | |
| components: clippy | |
| - run: rustup run ${{ matrix.rust }} cargo clippy --all --all-targets --all-features -- -D warnings | |
| fmt: | |
| name: Rustfmt | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| rust: | |
| # Once we settle on a MSRV we should add that here. | |
| - stable | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: ${{ matrix.rust }} | |
| components: rustfmt | |
| - run: rustup run ${{ matrix.rust}} cargo fmt --all -- --check | |
| docs: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| rust: | |
| - stable | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: ${{ matrix.rust }} | |
| - run: RUSTDOCFLAGS="-D warnings " rustup run ${{ matrix }} cargo doc --workspace --locked --no-deps --all-features | |
| test: | |
| name: Test | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| rust: | |
| # Once we settle on a MSRV we should add that here. | |
| - stable | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/toolchain@v1 | |
| with: | |
| profile: minimal | |
| toolchain: ${{ matrix.rust }} | |
| - run: rustup run ${{ matrix.rust }} cargo test | |
| typeshare: | |
| name: Typeshare | |
| runs-on: ubuntu-latest | |
| strategy: | |
| matrix: | |
| rust: | |
| - stable | |
| lang: | |
| - typescript | |
| - kotlin | |
| - swift | |
| include: | |
| - fs: ts | |
| lang: typescript | |
| - fs: kt | |
| lang: kotlin | |
| - fs: swift | |
| lang: swift | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions-rs/[email protected] | |
| with: | |
| crate: typeshare-cli | |
| version: "1.10.0-beta.6" | |
| - run: typeshare --lang=${{ matrix.lang }} . -o test.${{ matrix.fs }} |