docs: add an overview of the creation and querying of snapshots (#5270) #15999
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: | |
| pull_request: | |
| merge_group: | |
| push: | |
| branches: [main] | |
| env: | |
| CARGO_TERM_COLOR: always | |
| name: ci | |
| jobs: | |
| clippy: | |
| name: clippy | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dtolnay/rust-toolchain@clippy | |
| with: | |
| toolchain: nightly-2023-10-29 | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| cache-on-failure: true | |
| - run: cargo clippy --workspace --all-targets --all-features | |
| env: | |
| RUSTFLAGS: -D warnings | |
| docs: | |
| name: docs | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dtolnay/rust-toolchain@nightly | |
| with: | |
| toolchain: nightly-2023-10-29 | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| cache-on-failure: true | |
| - run: cargo docs --document-private-items | |
| env: | |
| # Keep in sync with ./book.yml:jobs.build | |
| # This should only add `-D warnings` | |
| RUSTDOCFLAGS: | |
| --cfg docsrs --show-type-layout --generate-link-to-definition --enable-index-page | |
| -Zunstable-options -D warnings | |
| fmt: | |
| name: fmt | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dtolnay/rust-toolchain@nightly | |
| with: | |
| toolchain: nightly-2023-10-29 | |
| components: rustfmt | |
| - run: cargo fmt --all --check | |
| grafana-lint: | |
| name: grafana lint | |
| runs-on: ubuntu-latest | |
| timeout-minutes: 30 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Check dashboard JSON with jq | |
| uses: sergeysova/jq-action@v2 | |
| with: | |
| cmd: jq empty etc/grafana/dashboards/overview.json | |
| lint-success: | |
| if: always() | |
| name: lint success | |
| runs-on: ubuntu-latest | |
| needs: [clippy, docs, fmt, grafana-lint] | |
| timeout-minutes: 30 | |
| steps: | |
| - name: Decide whether the needed jobs succeeded or failed | |
| uses: re-actors/alls-green@release/v1 | |
| with: | |
| jobs: ${{ toJSON(needs) }} |