executorch/.github/workflows/_link_check.yml at main · pytorch/executorch · 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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
on:
  workflow_call:
    inputs:
      ref:
        type: string
        required: true
      base_ref:
        description: >
          Base branch commit. Pull requests lint from its merge base with ref, pushes
          lint from it directly. Empty, or all zeros, means check the whole tree.
        type: string
        required: false
        default: ''

jobs:
  lint-urls:
    if: ${{ github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, 'skip-url-lint') }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
    timeout-minutes: 120
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ inputs.ref }}
          # Only the merge base path needs history, and it costs ~25s. Quote the
          # branches: bare 0 is falsy, so `&& 0 || 1` would always yield 1.
          fetch-depth: ${{ github.event_name == 'pull_request' && '0' || '1' }}
      - name: Lint URLs
        env:
          BASE_REF: ${{ inputs.base_ref }}
          HEAD_REF: ${{ inputs.ref }}
          FROM_MERGE_BASE: ${{ github.event_name == 'pull_request' }}
        run: |
          args=()
          # A push creating a tag or branch reports an all zero SHA no remote can serve.
          if [ -n "$BASE_REF" ] && [ "$BASE_REF" != "0000000000000000000000000000000000000000" ]; then
            if [ "$FROM_MERGE_BASE" = "true" ]; then
              git fetch --no-tags origin "$BASE_REF"
              # Where the branch left the base branch, not the base branch tip, or a
              # branch cut before recent commits is blamed for every line it merely
              # lacks. No merge base means no usable range, so leave args empty for a
              # whole tree scan: the scripts treat a bad range as nothing to check.
              if merge_base=$(git merge-base "$BASE_REF" "$HEAD_REF"); then
                args=("$merge_base" "$HEAD_REF")
              fi
            else
              git fetch --no-tags --depth=1 origin "$BASE_REF"
              args=("$BASE_REF" "$HEAD_REF")
            fi
          fi
          ./scripts/lint_urls.sh "${args[@]}" || {
            echo
            echo "URL lint failed."
            echo "If this is a transient outage, you can bypass it by adding the \`skip-url-lint\` label to your PR."
            echo "Or add \`@lint-ignore\` somewhere on the same line as the URL you want to skip checking."
            exit 1
          }

  lint-xrefs:
    if: ${{ github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, 'skip-xref-lint') }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
    timeout-minutes: 60
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ inputs.ref }}
          # Only the merge base path needs history, and it costs ~25s. Quote the
          # branches: bare 0 is falsy, so `&& 0 || 1` would always yield 1.
          fetch-depth: ${{ github.event_name == 'pull_request' && '0' || '1' }}
      - name: Lint cross-references
        env:
          BASE_REF: ${{ inputs.base_ref }}
          HEAD_REF: ${{ inputs.ref }}
          FROM_MERGE_BASE: ${{ github.event_name == 'pull_request' }}
        run: |
          args=()
          # A push creating a tag or branch reports an all zero SHA no remote can serve.
          if [ -n "$BASE_REF" ] && [ "$BASE_REF" != "0000000000000000000000000000000000000000" ]; then
            if [ "$FROM_MERGE_BASE" = "true" ]; then
              git fetch --no-tags origin "$BASE_REF"
              # Where the branch left the base branch, not the base branch tip, or a
              # branch cut before recent commits is blamed for every line it merely
              # lacks. No merge base means no usable range, so leave args empty for a
              # whole tree scan: the scripts treat a bad range as nothing to check.
              if merge_base=$(git merge-base "$BASE_REF" "$HEAD_REF"); then
                args=("$merge_base" "$HEAD_REF")
              fi
            else
              git fetch --no-tags --depth=1 origin "$BASE_REF"
              args=("$BASE_REF" "$HEAD_REF")
            fi
          fi
          ./scripts/lint_xrefs.sh "${args[@]}" || {
            echo
            echo "Xref lint failed."
            echo "If this is a transient outage, you can bypass it by adding the \`skip-xref-lint\` label to your PR."
            echo "Or add \`@lint-ignore\` somewhere on the same line as the reference you want to skip checking."
            exit 1
          }

  lint-file-size:
    if: ${{ github.event_name == 'pull_request' }}
    runs-on: ubuntu-latest
    permissions:
      contents: read
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@v4
        with:
          ref: ${{ inputs.ref }}
          # Only the merge base path needs history, and it costs ~25s. Quote the
          # branches: bare 0 is falsy, so `&& 0 || 1` would always yield 1.
          fetch-depth: ${{ github.event_name == 'pull_request' && '0' || '1' }}
      - name: Lint file sizes
        env:
          BASE_REF: ${{ inputs.base_ref }}
          HEAD_REF: ${{ inputs.ref }}
          FROM_MERGE_BASE: ${{ github.event_name == 'pull_request' }}
        run: |
          args=()
          # A push creating a tag or branch reports an all zero SHA no remote can serve.
          if [ -n "$BASE_REF" ] && [ "$BASE_REF" != "0000000000000000000000000000000000000000" ]; then
            if [ "$FROM_MERGE_BASE" = "true" ]; then
              git fetch --no-tags origin "$BASE_REF"
              # Where the branch left the base branch, not the base branch tip, or a
              # branch cut before recent commits is blamed for every line it merely
              # lacks. No merge base means no usable range, so leave args empty for a
              # whole tree scan: the scripts treat a bad range as nothing to check.
              if merge_base=$(git merge-base "$BASE_REF" "$HEAD_REF"); then
                args=("$merge_base" "$HEAD_REF")
              fi
            else
              git fetch --no-tags --depth=1 origin "$BASE_REF"
              args=("$BASE_REF" "$HEAD_REF")
            fi
          fi
          chmod +x ./scripts/lint_file_size.sh
          ./scripts/lint_file_size.sh "${args[@]}" || {
            echo
            echo "File size lint failed: some files exceed the 1 MB limit."
            echo "If you really need large files, consider using Git LFS or storing them elsewhere."
            echo "If you really need to get unblocked and check in the file, can add it to the EXCEPTIONS list in scripts/lint_file_size.sh."
            exit 1
          }