Fix check-docs.sh failing on macOS when an option has no values - #320
Open
jakepetroules wants to merge 1 commit into
Open
jakepetroules wants to merge 1 commit into
jakepetroules wants to merge 1 commit into
Conversation
Merged
2 of 13 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The macOS documentation check always fails immediately:
soundness.ymlalways passes--additional-docc-arguments ${ADDITIONAL_DOCC_ARGUMENTS}, so when no additional arguments are configured the option is passed with no values andcollectedstays empty. macOS runners use/bin/bash3.2, where expanding an empty array underset -uis treated as an unbound variable (bash 4.4+ allows it), so the script exits before building any documentation. The Linux docs check isn't affected because its container has a newer bash.--doc-targetshas the same problem, so this changes both expansions to"${collected[*]:-}".Tested locally with macOS
/bin/bash3.2.57 against a package:check-docs.sh --additional-docc-arguments(the default CI invocation): previously failed with the error above, now passescheck-docs.sh --no-analyze --doc-targets --additional-docc-arguments: passescheck-docs.sh --doc-targets <target> --additional-docc-arguments --include-extended-types: values are still forwarded togenerate-documentation, passes