docs: add helper overview and new examples #32
This file contains hidden or 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 ] | |
| env: | |
| CARGO_TERM_COLOR: never | |
| jobs: | |
| validate: | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| os: [ubuntu-latest, windows-latest] | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt, clippy | |
| - name: sync-version-refs | |
| if: matrix.os == 'ubuntu-latest' | |
| run: bash ./scripts/update-version.sh | |
| - name: sync-version-refs | |
| if: matrix.os == 'windows-latest' | |
| shell: pwsh | |
| run: ./scripts/update-version.ps1 | |
| - name: fmt | |
| run: cargo fmt --all -- --check | |
| - name: clippy | |
| run: cargo clippy --workspace --all-targets -- -D warnings | |
| - name: check | |
| run: cargo check --workspace --all-targets | |
| - name: doc | |
| run: cargo doc --no-deps --all-features | |
| publish: | |
| name: Publish to crates.io | |
| needs: validate | |
| if: startsWith(github.ref, 'refs/tags/v') | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - name: Publish teamtalk | |
| run: | | |
| cd crates/teamtalk | |
| cargo publish --token ${{ secrets.CRATES_IO_TOKEN }} |