docs: intial implementation based on rustdoc and mermaid #4158
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
| ##### | |
| # | |
| # when PR is updated by pushing changes to the branch | |
| # CI skips all jobs for Drafted PRs by default | |
| # CI skips all jobs for PRs labeled with `!ci-skip` | |
| # | |
| # Labels: | |
| # !ci-draft - runs CI for drafted PR | |
| # !ci-codecov - runs Code Coverage job on every PR update | |
| # !ci-audit - runs Cargo Audit job on every PR update | |
| # !ci-integration - runs Integration Tests on every PR updates | |
| # !ci-skip - skips All jobs | |
| # | |
| name: Self-Hosted | |
| on: | |
| push: | |
| # yes, only trying and staging | |
| # merging is just a setting branch head to the succeeded staging commit | |
| # so there is no reason to execute workflow again | |
| branches: [ trying, staging ] | |
| pull_request: | |
| types: [ synchronize, opened, ready_for_review, labeled, unlabeled ] | |
| paths-ignore: | |
| - '**/*.md' # do not run CI on pull_request update if just MD files are changed | |
| concurrency: | |
| # do not run more than once for latest push/update | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: true | |
| permissions: | |
| contents: read | |
| pull-requests: write | |
| statuses: write | |
| checks: write | |
| env: | |
| CARGO_INCREMENTAL: 0 | |
| CARGO_TERM_COLOR: always | |
| jobs: | |
| test: | |
| name: Build and test | |
| runs-on: [self-hosted, rust-check] | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| submodules: recursive | |
| - name: Install Foundry | |
| uses: foundry-rs/foundry-toolchain@v1 | |
| - run: sudo apt-get update -y | |
| - run: sudo add-apt-repository ppa:ethereum/ethereum | |
| - run: sudo apt-get install -y protobuf-compiler solc | |
| - run: forge fmt --check | |
| - run: forge test -vvv --block-gas-limit=30000000 --optimize --optimizer-runs=200000 --evm-version=shanghai --use=0.8.25 --root analog-gmp | |
| - run: cargo +stable fmt --all -- --check | |
| - run: cargo +stable test --workspace --locked | |
| - run: cargo +stable check --features runtime-benchmarks | |
| - run: cargo +stable check --features try-runtime | |
| - uses: actions-rs/clippy-check@v1 | |
| with: | |
| name: Clippy Report | |
| token: ${{secrets.GITHUB_TOKEN}} | |
| toolchain: stable | |
| # `--no-deps` does not check dependencies out of workspace | |
| # `--all-features` doesn't work atm | |
| args: --all-targets --workspace --examples --tests -- --no-deps -D warnings | |
| audit: | |
| name: Cargo Audit | |
| runs-on: self-hosted | |
| if: ${{ | |
| github.event_name == 'push' || | |
| contains(github.event.pull_request.labels.*.name,'!ci-codecov') | |
| }} | |
| env: | |
| BUILD_OPTS: ${{needs.conditions.outputs.build-opts}} | |
| CLIPPY_OPTS: ${{needs.conditions.outputs.clippy-opts}} | |
| TARGET: ${{needs.conditions.outputs.target}} | |
| WASM_BUILD_TOOLCHAIN: ${{needs.conditions.outputs.toolchain}} | |
| RUSTUP_TOOLCHAIN: ${{needs.conditions.outputs.toolchain}} | |
| EXCLUDE_TESTS: ${{needs.conditions.outputs.exclude-tests}} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| - run: cargo install cargo-audit --locked | |
| - name: Audit | |
| run: | | |
| $r = (cargo audit -q --json | ConvertFrom-Json) | |
| $e = $? | |
| $r.vulnerabilities.list | Select-Object -ExpandProperty Advisory | |
| if (!$e) { exit 1 } | |
| shell: pwsh | |
| code-coverage: | |
| name: Report Code Coverage | |
| runs-on: self-hosted | |
| if: ${{ | |
| github.event_name == 'push' || | |
| contains(github.event.pull_request.labels.*.name,'!ci-audit') | |
| }} | |
| env: | |
| BUILD_OPTS: ${{needs.conditions.outputs.build-opts}} | |
| CLIPPY_OPTS: ${{needs.conditions.outputs.clippy-opts}} | |
| TARGET: ${{needs.conditions.outputs.target}} | |
| WASM_BUILD_TOOLCHAIN: ${{needs.conditions.outputs.toolchain}} | |
| RUSTUP_TOOLCHAIN: ${{needs.conditions.outputs.toolchain}} | |
| EXCLUDE_TESTS: ${{needs.conditions.outputs.exclude-tests}} | |
| steps: | |
| - name: Checkout sources | |
| uses: actions/checkout@v4 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| - run: sudo apt-get install -y protobuf-compiler | |
| - name: Setup llvm-cov for cargo | |
| uses: taiki-e/install-action@cargo-llvm-cov | |
| - name: Unit Tests | |
| # use --tests to measure coverage with all tests | |
| # use --test '*' to measure coverage with integration-tests | |
| # use --lib to measure coverage with unit-tests | |
| run: | | |
| cargo llvm-cov test --lib --locked --workspace \ | |
| --lcov --output-path lcov.info $BUILD_OPTS \ | |
| $(for i in $EXCLUDE_TESTS; do echo "--exclude $i"; done ) | |
| - name: Upload coverage to Codecov | |
| uses: codecov/codecov-action@v3 | |
| with: | |
| token: ${{ secrets.CODECOV_TOKEN }} | |
| files: lcov.info | |
| fail_ci_if_error: true |