Append swift-docc-plugin only when needed #109
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
fboemer
commented
Mar 21, 2025
| for package_file in $package_files; do | ||
| log "Editing $package_file..." | ||
| cat <<EOF >> "$package_file" | ||
| # yq 3.1.0-3 doesn't have filter, otherwise we could replace the grep call with "filter(.identity == "swift-docc-plugin") | keys | .[]" |
There was a problem hiding this comment.
- Trying out filter via
hasDoccPlugin=$(swift package dump-package | yq -r '.dependencies[].sourceControl | filter(.identity == "swift-docc-plugin") | keys | .[]')
https://github.com/fboemer/swift-homomorphic-encryption/actions/runs/13997912746/job/39197486713
jq: error: filter/1 is not defined at <top-level>, line 1:[222](https://github.com/fboemer/swift-homomorphic-encryption/actions/runs/13997912746/job/39197486713#step:5:223)
.dependencies[].sourceControl | filter(.identity == "swift-docc-plugin") | keys | .[]
jq: 1 compile error
yq: Error running jq: BrokenPipeError: [Errno 32] Broken pipe.
ahoppen
reviewed
Mar 21, 2025
| log "Editing $package_file..." | ||
| cat <<EOF >> "$package_file" | ||
| # yq 3.1.0-3 doesn't have filter, otherwise we could replace the grep call with "filter(.identity == "swift-docc-plugin") | keys | .[]" | ||
| hasDoccPlugin=$(swift package dump-package | yq -r '.dependencies[].sourceControl' | grep -e "\"identity\": \"swift-docc-plugin\"" || true ) |
There was a problem hiding this comment.
swift package dump-package is JSON, so should this be jq instead of yq?
Also: Trailing space after true)
There was a problem hiding this comment.
We already use yq later on in the script, so I figured no need to an extra dependency, since yq supports json (as well as yaml)
Also: Trailing space after true)
Fixed
fboemer
force-pushed
the
fboemer/append-docc-plugin-only-when-needed
branch
from
8107807 to
a74cf14
Compare
ahoppen
approved these changes
Mar 21, 2025
FranzBusch
approved these changes
Mar 22, 2025
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.
Currently, the
docs-check:workflow always adds theswift-docc-plugindependency, forcing adopters to remove the dependency from their package. This PR edits the docs check to skip adding the dependency when already present.A package with swift-docc-plugin: https://github.com/fboemer/swift-homomorphic-encryption/actions/runs/13997582365/job/39196407070?pr=3#step:5:222
A package without swift-docc-plugin: https://github.com/fboemer/swift-homomorphic-encryption/actions/runs/13997685223/job/39196742443#step:5:222