Add mermaid support for our mdbook #78
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: test-suite | |
| on: | |
| push: | |
| branches: | |
| - stable | |
| - 'pr/*' | |
| pull_request: | |
| merge_group: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| # Deny warnings in CI | |
| # Disable debug info (see https://github.com/sigp/lighthouse/issues/4005) | |
| RUSTFLAGS: "-D warnings -C debuginfo=0" | |
| # Prevent Github API rate limiting. | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # Enable self-hosted runners for the Anchor repo only. | |
| SELF_HOSTED_RUNNERS: false # ${{ github.repository == 'sigp/anchor' }} | |
| # Self-hosted runners need to reference a different host for `./watch` tests. | |
| WATCH_HOST: ${{ github.repository == 'sigp/anchor' && 'host.docker.internal' || 'localhost' }} | |
| # Disable incremental compilation | |
| CARGO_INCREMENTAL: 0 | |
| # Enable portable to prevent issues with caching `blst` for the wrong CPU type | |
| # TEST_FEATURES: portable | |
| jobs: | |
| check-labels: | |
| runs-on: ubuntu-latest | |
| name: Check for 'skip-ci' label | |
| outputs: | |
| skip_ci: ${{ steps.set-output.outputs.SKIP_CI }} | |
| steps: | |
| - name: check for skip-ci label | |
| id: set-output | |
| env: | |
| LABELS: ${{ toJson(github.event.pull_request.labels) }} | |
| run: | | |
| SKIP_CI="false" | |
| if [ -z "${LABELS}" ] || [ "${LABELS}" = "null" ]; then | |
| LABELS="none"; | |
| else | |
| LABELS=$(echo ${LABELS} | jq -r '.[].name') | |
| fi | |
| for label in ${LABELS}; do | |
| if [ "$label" = "skip-ci" ]; then | |
| SKIP_CI="true" | |
| break | |
| fi | |
| done | |
| echo "skip_ci=$SKIP_CI" >> $GITHUB_OUTPUT | |
| target-branch-check: | |
| name: target-branch-check | |
| runs-on: ubuntu-latest | |
| if: github.event_name == 'pull_request' || github.event_name == 'merge_group' | |
| steps: | |
| - name: Check that the pull request is not targeting the stable branch | |
| run: test ${{ github.base_ref }} != "stable" | |
| release-tests-ubuntu: | |
| name: release-tests-ubuntu | |
| needs: [check-labels] | |
| if: needs.check-labels.outputs.skip_ci != 'true' | |
| # Use self-hosted runners only on the sigp repo. | |
| runs-on: ubuntu-latest #${{ github.repository == 'sigp/anchor' && fromJson('["self-hosted", "linux", "CI", "large"]') || 'ubuntu-latest' }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Get latest version of stable Rust | |
| if: env.SELF_HOSTED_RUNNERS == 'false' | |
| uses: moonrepo/setup-rust@v1 | |
| with: | |
| channel: stable | |
| cache-target: release | |
| bins: cargo-nextest | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Run tests in release | |
| run: make nextest-release | |
| - name: Show cache stats | |
| if: env.SELF_HOSTED_RUNNERS == 'true' | |
| run: sccache --show-stats | |
| debug-tests-ubuntu: | |
| name: debug-tests-ubuntu | |
| needs: [check-labels] | |
| if: needs.check-labels.outputs.skip_ci != 'true' | |
| # Use self-hosted runners only on the sigp repo. | |
| runs-on: ubuntu-latest #${{ github.repository == 'sigp/anchor' && fromJson('["self-hosted", "linux", "CI", "large"]') || 'ubuntu-latest' }} | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Get latest version of stable Rust | |
| if: env.SELF_HOSTED_RUNNERS == 'false' | |
| uses: moonrepo/setup-rust@v1 | |
| with: | |
| channel: stable | |
| bins: cargo-nextest | |
| - name: Run tests in debug | |
| run: make nextest-debug | |
| - name: Show cache stats | |
| if: env.SELF_HOSTED_RUNNERS == 'true' | |
| run: sccache --show-stats | |
| check-code: | |
| name: check-code | |
| runs-on: ubuntu-latest | |
| env: | |
| CARGO_INCREMENTAL: 1 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Get latest version of stable Rust | |
| uses: moonrepo/setup-rust@v1 | |
| with: | |
| channel: stable | |
| cache-target: release | |
| components: rustfmt,clippy | |
| bins: cargo-audit | |
| - name: Check formatting with cargo fmt | |
| run: make cargo-fmt | |
| - name: Lint code for quality and style with Clippy | |
| run: make lint | |
| - name: Certify Cargo.lock freshness | |
| run: git diff --exit-code Cargo.lock | |
| - name: Run cargo audit | |
| run: make audit-CI | |
| # Dependency conflicts are causing pain here. Once SLOG is removed from lighthouse this should | |
| # be re-enabled | |
| # - name: Run cargo vendor to make sure dependencies can be vendored for packaging, reproducibility and archival purpose | |
| #run: CARGO_HOME=$(readlink -f $HOME) make vendor | |
| - name: Markdown-linter | |
| run: make mdlint | |
| check-msrv: | |
| name: check-msrv | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Rust at Minimum Supported Rust Version (MSRV) | |
| run: | | |
| metadata=$(cargo metadata --no-deps --format-version 1) | |
| msrv=$(echo $metadata | jq -r '.packages | map(select(.name == "anchor")) | .[0].rust_version') | |
| rustup override set $msrv | |
| - name: Run cargo check | |
| run: cargo check --workspace | |
| cargo-udeps: | |
| name: cargo-udeps | |
| needs: [check-labels] | |
| if: needs.check-labels.outputs.skip_ci != 'true' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Get latest version of nightly Rust | |
| uses: moonrepo/setup-rust@v1 | |
| with: | |
| channel: nightly | |
| bins: cargo-udeps | |
| cache: false | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Create Cargo config dir | |
| run: mkdir -p .cargo | |
| - name: Install custom Cargo config | |
| run: cp -f .github/custom/config.toml .cargo/config.toml | |
| - name: Run cargo udeps to identify unused crates in the dependency graph | |
| run: make udeps | |
| env: | |
| # Allow warnings on Nightly | |
| RUSTFLAGS: "" | |
| spell-check: | |
| name: spellcheck | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| # Uses the canonical version so that the version is up to date: | |
| # https://github.com/rojopolis/spellcheck-github-actions?tab=readme-ov-file#using-a-canonical-version | |
| - uses: rojopolis/spellcheck-github-actions@v0 | |
| # cli-check: | |
| # name: cli-check | |
| # needs: [check-labels] | |
| # if: needs.check-labels.outputs.skip_ci != 'true' | |
| # runs-on: ubuntu-latest | |
| # steps: | |
| # - uses: actions/checkout@v4 | |
| # - name: Get latest version of stable Rust | |
| # uses: moonrepo/setup-rust@v1 | |
| # with: | |
| # channel: stable | |
| # cache-target: release | |
| # - name: Run Makefile to trigger the bash script | |
| # run: make cli |