Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify check-docs.sh early-exit #63

Merged
merged 1 commit into from
Nov 13, 2024
Merged

Commits on Nov 13, 2024

  1. Clarify check-docs.sh early-exit

    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.
    ```
    rnro authored Nov 13, 2024
    Configuration menu
    Copy the full SHA
    1c463fd View commit details
    Browse the repository at this point in the history