mit-learn/.github/workflows/openapi-diff.yml at main · mitodl/mit-learn · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
name: OpenAPI Diff
on: [pull_request]
jobs:
  openapi-diff:
    runs-on: ubuntu-24.04
    steps:
      - name: Checkout HEAD
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
        with:
          ref: ${{ github.head_ref }}
          path: head
      - name: Checkout BASE
        uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
        with:
          ref: ${{ github.base_ref }}
          path: base
      - name: Generate oasdiff changelog
        id: oasdif_changelog
        run: | # Capture changelog as a multiline output
          echo "changelog<<EOF" > $GITHUB_OUTPUT
          docker run --rm \
            --workdir ${{ github.workspace }} \
            --volume ${{ github.workspace }}:${{ github.workspace }}:rw \
            -e GITHUB_WORKSPACE=${{ github.workspace }} \
            tufin/oasdiff changelog --composed \
            'base/openapi/specs/*.yaml' \
            'head/openapi/specs/*.yaml' \
            >> $GITHUB_OUTPUT
          echo "EOF" >> $GITHUB_OUTPUT
      - name: Get summary
        id: oasdif_summary
        run: |
          echo summary=$(echo "${{ steps.oasdif_changelog.outputs.changelog }}" | head -1 ) \
          >> $GITHUB_OUTPUT
      - name: Find existing comment
        id: find_comment
        uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad # v4
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          repository: ${{ github.repository }}
          issue-number: ${{ github.event.pull_request.number }}
          body-includes: "## OpenAPI Changes"
      - name: Post changes as comment
        uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9 # v5
        # Even if no changes, make sure to update old comment if it was found.
        if: steps.oasdif_summary.outputs.summary || steps.find_comment.outputs.comment-id
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          edit-mode: "replace"
          repository: ${{ github.repository }}
          issue-number: ${{ github.event.pull_request.number }}
          comment-id: ${{ steps.find_comment.outputs.comment-id }}
          body: |
            ## OpenAPI Changes

            <details>
            <summary>Show/hide ${{ steps.oasdif_summary.outputs.summary || 'No detectable change.' }}</summary>

            ```
            ${{ steps.oasdif_changelog.outputs.changelog }}
            ```

            Unexpected changes? Ensure your branch is up-to-date with `main` (consider rebasing).
            </details>
      - name: Check for breaking changes
        id: oasdif_breaking
        run: |
          docker run --rm \
            --workdir ${{ github.workspace }} \
            --volume ${{ github.workspace }}:${{ github.workspace }}:ro \
            -e GITHUB_WORKSPACE=${{ github.workspace }} \
            tufin/oasdiff breaking \
            --fail-on ERR \
            --format githubactions \
            --composed \
            'base/openapi/specs/*.yaml' \
            'head/openapi/specs/*.yaml'