Skip to content

Commit 67e53bf

Browse files
committed
Enable one level of git submodules for soundness checks
Motivation: Submodules are used by some repos. Note: Not all the soundness checks strictly need submodules but when working locally you'll have submodules checked out which can break the various linters so to keep local workflows functional it's best to get submodules for PR too. Modifications: Make the checkout action get one level of submodules for soundness checks. Result: Soundness more generally correct.
1 parent eb15ee4 commit 67e53bf

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

.github/workflows/soundness.yml

+9
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ jobs:
8282
uses: actions/checkout@v4
8383
with:
8484
persist-credentials: false
85+
submodules: true
8586
- name: Mark the workspace as safe
8687
# https://github.com/actions/checkout/issues/766
8788
run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
@@ -102,6 +103,7 @@ jobs:
102103
uses: actions/checkout@v4
103104
with:
104105
persist-credentials: false
106+
submodules: true
105107
- name: Run documentation check
106108
run: |
107109
apt-get -qq update && apt-get -qq -y install curl yq
@@ -117,6 +119,7 @@ jobs:
117119
uses: actions/checkout@v4
118120
with:
119121
persist-credentials: false
122+
submodules: true
120123
- name: Run unacceptable language check
121124
env:
122125
UNACCEPTABLE_WORD_LIST: ${{ inputs.unacceptable_language_check_word_list}}
@@ -132,6 +135,7 @@ jobs:
132135
uses: actions/checkout@v4
133136
with:
134137
persist-credentials: false
138+
submodules: true
135139
- name: Run license header check
136140
env:
137141
PROJECT_NAME: ${{ inputs.license_header_check_project_name }}
@@ -147,6 +151,7 @@ jobs:
147151
uses: actions/checkout@v4
148152
with:
149153
persist-credentials: false
154+
submodules: true
150155
- name: Run broken symlinks check
151156
run: curl -s https://raw.githubusercontent.com/swiftlang/github-workflows/refs/heads/main/.github/workflows/scripts/check-broken-symlinks.sh | bash
152157

@@ -162,6 +167,7 @@ jobs:
162167
uses: actions/checkout@v4
163168
with:
164169
persist-credentials: false
170+
submodules: true
165171
- name: Mark the workspace as safe
166172
# https://github.com/actions/checkout/issues/766
167173
run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
@@ -182,6 +188,7 @@ jobs:
182188
uses: actions/checkout@v4
183189
with:
184190
persist-credentials: false
191+
submodules: true
185192
- name: Mark the workspace as safe
186193
# https://github.com/actions/checkout/issues/766
187194
run: git config --global --add safe.directory ${GITHUB_WORKSPACE}
@@ -200,6 +207,7 @@ jobs:
200207
uses: actions/checkout@v4
201208
with:
202209
persist-credentials: false
210+
submodules: true
203211
- name: Run yamllint
204212
run: |
205213
which yamllint >/dev/null || ( apt-get update && apt-get install -y yamllint )
@@ -215,6 +223,7 @@ jobs:
215223
uses: actions/checkout@v4
216224
with:
217225
persist-credentials: false
226+
submodules: true
218227
- name: Run flake8
219228
run: |
220229
pip3 install flake8 flake8-import-order

0 commit comments

Comments
 (0)