|
| 1 | +name: Lintcheck |
| 2 | + |
| 3 | +on: pull_request |
| 4 | + |
| 5 | +env: |
| 6 | + RUST_BACKTRACE: 1 |
| 7 | + CARGO_INCREMENTAL: 0 |
| 8 | + |
| 9 | +concurrency: |
| 10 | + # For a given workflow, if we push to the same PR, cancel all previous builds on that PR. |
| 11 | + group: "${{ github.workflow }}-${{ github.event.pull_request.number}}" |
| 12 | + cancel-in-progress: true |
| 13 | + |
| 14 | +jobs: |
| 15 | + # Generates `lintcheck-logs/base.json` and stores it in a cache |
| 16 | + base: |
| 17 | + runs-on: ubuntu-latest |
| 18 | + |
| 19 | + outputs: |
| 20 | + key: ${{ steps.key.outputs.key }} |
| 21 | + |
| 22 | + steps: |
| 23 | + - name: Checkout |
| 24 | + uses: actions/checkout@v4 |
| 25 | + with: |
| 26 | + fetch-depth: 2 |
| 27 | + |
| 28 | + # HEAD is the generated merge commit `refs/pull/N/merge` between the PR and `master`, `HEAD^` |
| 29 | + # being the commit from `master` that is the base of the merge |
| 30 | + - name: Checkout base |
| 31 | + run: git checkout HEAD^ |
| 32 | + |
| 33 | + # Use the lintcheck from the PR to generate the JSON in case the PR modifies lintcheck in some |
| 34 | + # way |
| 35 | + - name: Checkout current lintcheck |
| 36 | + run: | |
| 37 | + rm -rf lintcheck |
| 38 | + git checkout ${{ github.sha }} -- lintcheck |
| 39 | +
|
| 40 | + - name: Create cache key |
| 41 | + id: key |
| 42 | + run: echo "key=lintcheck-base-${{ hashfiles('lintcheck/**') }}-$(git rev-parse HEAD)" >> "$GITHUB_OUTPUT" |
| 43 | + |
| 44 | + - name: Cache results |
| 45 | + id: cache |
| 46 | + uses: actions/cache@v4 |
| 47 | + with: |
| 48 | + path: lintcheck-logs/base.json |
| 49 | + key: ${{ steps.key.outputs.key }} |
| 50 | + |
| 51 | + - name: Run lintcheck |
| 52 | + if: steps.cache.outputs.cache-hit != 'true' |
| 53 | + run: cargo lintcheck --format json |
| 54 | + |
| 55 | + - name: Rename JSON file |
| 56 | + if: steps.cache.outputs.cache-hit != 'true' |
| 57 | + run: mv lintcheck-logs/lintcheck_crates_logs.json lintcheck-logs/base.json |
| 58 | + |
| 59 | + # Generates `lintcheck-logs/head.json` and stores it in a cache |
| 60 | + head: |
| 61 | + runs-on: ubuntu-latest |
| 62 | + |
| 63 | + outputs: |
| 64 | + key: ${{ steps.key.outputs.key }} |
| 65 | + |
| 66 | + steps: |
| 67 | + - name: Checkout |
| 68 | + uses: actions/checkout@v4 |
| 69 | + |
| 70 | + - name: Create cache key |
| 71 | + id: key |
| 72 | + run: echo "key=lintcheck-head-${{ github.sha }}" >> "$GITHUB_OUTPUT" |
| 73 | + |
| 74 | + - name: Cache results |
| 75 | + id: cache |
| 76 | + uses: actions/cache@v4 |
| 77 | + with: |
| 78 | + path: lintcheck-logs/head.json |
| 79 | + key: ${{ steps.key.outputs.key }} |
| 80 | + |
| 81 | + - name: Run lintcheck |
| 82 | + if: steps.cache.outputs.cache-hit != 'true' |
| 83 | + run: cargo lintcheck --format json |
| 84 | + |
| 85 | + - name: Rename JSON file |
| 86 | + if: steps.cache.outputs.cache-hit != 'true' |
| 87 | + run: mv lintcheck-logs/lintcheck_crates_logs.json lintcheck-logs/head.json |
| 88 | + |
| 89 | + # Retrieves `lintcheck-logs/base.json` and `lintcheck-logs/head.json` from the cache and prints |
| 90 | + # the diff to the GH actions step summary |
| 91 | + diff: |
| 92 | + runs-on: ubuntu-latest |
| 93 | + |
| 94 | + needs: [base, head] |
| 95 | + |
| 96 | + steps: |
| 97 | + - name: Checkout |
| 98 | + uses: actions/checkout@v4 |
| 99 | + |
| 100 | + - name: Restore base JSON |
| 101 | + uses: actions/cache/restore@v4 |
| 102 | + with: |
| 103 | + key: ${{ needs.base.outputs.key }} |
| 104 | + path: lintcheck-logs/base.json |
| 105 | + fail-on-cache-miss: true |
| 106 | + |
| 107 | + - name: Restore head JSON |
| 108 | + uses: actions/cache/restore@v4 |
| 109 | + with: |
| 110 | + key: ${{ needs.head.outputs.key }} |
| 111 | + path: lintcheck-logs/head.json |
| 112 | + fail-on-cache-miss: true |
| 113 | + |
| 114 | + - name: Diff results |
| 115 | + run: cargo lintcheck diff lintcheck-logs/base.json lintcheck-logs/head.json >> $GITHUB_STEP_SUMMARY |
0 commit comments