Add documentation for public APIs #422
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
| name: CI | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| branches: [main] | |
| types: [opened, synchronize, reopened] | |
| workflow_dispatch: | |
| schedule: [cron: "44 4 * * 6"] | |
| permissions: | |
| contents: read | |
| env: | |
| # RUSTFLAGS: -Dwarnings | |
| TEST_DATABASE_URL: postgres://postgres:postgres@localhost:5432/chaindexing_tests | |
| jobs: | |
| test: | |
| name: Rust ${{matrix.rust}} | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 45 | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| rust: [stable] | |
| services: | |
| postgres: | |
| image: postgres | |
| env: | |
| POSTGRES_PASSWORD: postgres | |
| POSTGRES_USER: postgres | |
| ports: | |
| - 5432:5432 | |
| options: >- | |
| --health-cmd pg_isready | |
| --health-interval 10s | |
| --health-timeout 5s | |
| --health-retries 5 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| toolchain: ${{matrix.rust}} | |
| - name: Setup Database | |
| run: cargo run -p chaindexing-tests | |
| - name: Run Tests | |
| run: cargo test | |
| clippy: | |
| name: Clippy | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 45 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dtolnay/rust-toolchain@clippy | |
| - run: cargo clippy --tests -- -Dclippy::all | |
| fmt: | |
| name: fmt | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dtolnay/rust-toolchain@stable | |
| with: | |
| components: rustfmt | |
| - uses: Swatinem/rust-cache@v2 | |
| # Check fmt | |
| - name: "rustfmt --check" | |
| # Workaround for rust-lang/cargo#7732 | |
| run: | | |
| if ! rustfmt --check --edition 2021 $(git ls-files '*.rs'); then | |
| printf "Please run \`rustfmt --edition 2021 \$(git ls-files '*.rs')\` to fix rustfmt errors.\n" >&2 | |
| exit 1 | |
| fi | |
| outdated: | |
| name: Outdated | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 45 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dtolnay/install@cargo-outdated | |
| - run: cargo outdated --workspace --exit-code 1 |