Clarify check-docs.sh early-exit #63
Merged
Conversation
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
In the event that there is no `.spi.yml` file, the script currently exits messily:
```
** Editing Package.swift...
** Checking documentation targets...
usage: yq [-h] [--yaml-output] [--yaml-roundtrip]
[--yaml-output-grammar-version {1.1,1.2}] [--width WIDTH]
[--indentless-lists] [--in-place] [--version]
[jq_filter] [files ...]
yq: error: argument files: can't open '.spi.yml': [Errno 2] No such file or directory: '.spi.yml'
** ✅ Found no documentation issues.
```
Not having an `.spi.yml` file is perfectly valid if the repository has no defined documentation targets. This change results in the following behavior:
```
** No '.spi.yml' found, no documentation targets to check.
```
shahmishal
approved these changes
Nov 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
In the event that there is no
.spi.ymlfile, the script currently exits messily:Not having an
.spi.ymlfile is perfectly valid if the repository has no defined documentation targets. This change results in the following behavior: