documentation: add walkthrough, tech-docs, overview (#10) #6
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: "Correctness checks and linting" | |
| on: | |
| push: | |
| branches: ["main"] | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| workflow_dispatch: | |
| workflow_call: | |
| inputs: | |
| workflow: | |
| required: true | |
| type: string | |
| secrets: | |
| CC_BUILD_TOKEN: | |
| required: true | |
| GH_DOTCOM_TOKEN: | |
| required: true | |
| env: | |
| REV: ${{ github.run_id }} | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }}-${{ inputs.workflow }} | |
| cancel-in-progress: true | |
| jobs: | |
| fmt: | |
| strategy: | |
| matrix: | |
| runner: ["self-hosted-linux-amd64"] | |
| runs-on: ${{ matrix.runner }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: ./.github/actions/setup | |
| with: | |
| ghe-token: ${{ secrets.CC_BUILD_TOKEN }} | |
| gh-token: ${{ secrets.GH_DOTCOM_TOKEN }} | |
| runner: ${{ matrix.runner }} | |
| - name: Check formatting | |
| run: cargo make check-fmt | |
| clippy: | |
| strategy: | |
| matrix: | |
| runner: ["self-hosted-linux-amd64"] | |
| runs-on: ${{ matrix.runner }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: ./.github/actions/setup | |
| with: | |
| ghe-token: ${{ secrets.CC_BUILD_TOKEN }} | |
| gh-token: ${{ secrets.GH_DOTCOM_TOKEN }} | |
| runner: ${{ matrix.runner }} | |
| - name: Run clippy | |
| run: cargo make clippy | |
| machete: | |
| strategy: | |
| matrix: | |
| runner: ["self-hosted-linux-amd64"] | |
| runs-on: ${{ matrix.runner }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: ./.github/actions/setup | |
| with: | |
| ghe-token: ${{ secrets.CC_BUILD_TOKEN }} | |
| gh-token: ${{ secrets.GH_DOTCOM_TOKEN }} | |
| runner: ${{ matrix.runner }} | |
| - name: Check dependency usage | |
| run: cargo make machete | |
| check: | |
| strategy: | |
| matrix: | |
| runner: | |
| # TODO(eric): re-enable after we get macOS runners. | |
| # - "macos-latest" | |
| - "self-hosted-linux-arm" | |
| - "self-hosted-linux-arm64" | |
| - "self-hosted-linux-amd64" | |
| runs-on: ${{ matrix.runner }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Setup Environment | |
| uses: ./.github/actions/setup | |
| with: | |
| ghe-token: ${{ secrets.CC_BUILD_TOKEN }} | |
| gh-token: ${{ secrets.GH_DOTCOM_TOKEN }} | |
| runner: ${{ matrix.runner }} | |
| - name: Check Features | |
| run: cargo make check-features |