Skip to content

Commit f87ef4d

Browse files
committed
Update dock check syntax issue
1 parent d65527a commit f87ef4d

2 files changed

Lines changed: 16 additions & 13 deletions

File tree

.github/workflows/scripts/check-docs.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ done
8181

8282
if [ -z "${docs_targets}" ] ; then
8383
if [ ! -f .spi.yml ]; then
84-
log "No '.spi.yml' found, no documentation targets to check."
84+
log "No '.spi.yml' found in \"$(pwd)\", no documentation targets to check."
8585
exit 0
8686
fi
8787
fi
@@ -99,7 +99,7 @@ fi
9999

100100
package_files=$(find . -maxdepth 1 -name 'Package*.swift')
101101
if [ -z "$package_files" ]; then
102-
fatal "Package.swift not found. Please ensure you are running this script from the root of a Swift package."
102+
fatal "Package.swift not found in \"$(pwd)\". Please ensure you are running this script from the root of a Swift package."
103103
fi
104104

105105
# yq 3.1.0-3 doesn't have filter, otherwise we could replace the grep call with "filter(.identity == "swift-docc-plugin") | keys | .[]"

.github/workflows/soundness.yml

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ on:
1818
api_breakage_check_container_image:
1919
type: string
2020
description: "Container image for the API breakage check job. Defaults to latest Swift Ubuntu image."
21-
default: "swift:6.2-noble"
21+
default: "swift:6.3-noble"
2222
docs_check_enabled:
2323
type: boolean
2424
description: "Boolean to enable the docs check job. Defaults to true."
2525
default: true
2626
docs_check_container_image:
2727
type: string
2828
description: "Container image for the docs check job. Defaults to latest Swift Ubuntu image."
29-
default: "swift:6.2-noble"
29+
default: "swift:6.3-noble"
3030
docs_check_additional_arguments:
3131
type: string
3232
description: "Additional arguments that should be passed to docc"
@@ -94,7 +94,7 @@ on:
9494
format_check_container_image:
9595
type: string
9696
description: "Container image for the format check job. Defaults to latest Swift Ubuntu image."
97-
default: "swift:6.2-noble"
97+
default: "swift:6.3-noble"
9898
shell_check_enabled:
9999
type: boolean
100100
description: "Boolean to enable the shell check job. Defaults to true."
@@ -200,25 +200,27 @@ jobs:
200200
else
201201
echo "root=$GITHUB_WORKSPACE/github-workflows" >> $GITHUB_OUTPUT
202202
fi
203-
- name: Pre-build
204-
if: ${{ inputs.linux_pre_build_command }}
205-
# zizmor: ignore[template-injection]
206-
run: ${{ inputs.linux_pre_build_command }}
203+
# - name: Pre-build
204+
# if: ${{ inputs.linux_pre_build_command }}
205+
# # zizmor: ignore[template-injection]
206+
# run: ${{ inputs.linux_pre_build_command }}
207207
- name: Run documentation check
208208
env:
209209
ADDITIONAL_DOCC_ARGUMENTS: ${{ inputs.docs_check_additional_arguments }}
210210
DOCC_ANALYZE: ${{ inputs.docs_check_analyze }}
211211
DOCS_TARGETS: ${{ inputs.docs_check_targets}}
212212
SCRIPT_ROOT: ${{ steps.script_path.outputs.root }}
213213
run: |
214+
${{ inputs.linux_pre_build_command }}
214215
analyze_arg=""
215216
doc_target_arg=""
216-
if [[ "${DOCS_TARGETS}" != "" ]] ; then
217+
if [ "${DOCS_TARGETS}" != "" ] ; then
217218
doc_target_arg="--doc-targets ${DOCS_TARGETS}"
218219
fi
219-
if [[ "${DOCC_ANALYZE}" != "true" ]]; then
220+
if [ "${DOCC_ANALYZE}" != "true" ]; then
220221
analyze_arg="--no-analyze"
221222
fi
223+
set -x
222224
"${SCRIPT_ROOT}/.github/workflows/scripts/check-docs.sh" ${analyze_arg} ${doc_target_arg} --additional-docc-arguments ${ADDITIONAL_DOCC_ARGUMENTS}
223225
224226
docs-check-macos:
@@ -263,12 +265,13 @@ jobs:
263265
run: |
264266
analyze_arg=""
265267
doc_target_arg=""
266-
if [[ "${DOCS_TARGETS}" != "" ]] ; then
268+
if [ "${DOCS_TARGETS}" != "" ] ; then
267269
doc_target_arg="--doc-targets ${DOCS_TARGETS}"
268270
fi
269-
if [[ "${DOCC_ANALYZE}" != "true" ]]; then
271+
if [ "${DOCC_ANALYZE}" != "true" ]; then
270272
analyze_arg="--no-analyze"
271273
fi
274+
set -x
272275
"${SCRIPT_ROOT}/.github/workflows/scripts/check-docs.sh" ${analyze_arg} ${doc_target_arg} --additional-docc-arguments ${ADDITIONAL_DOCC_ARGUMENTS}
273276
274277
unacceptable-language-check:

0 commit comments

Comments
 (0)