docs(sips/006-spin-plugins): Fix typo in package.os field definition: osx -> macos
#3011
Conversation
This file contains 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
…n (`osx` -> `macos`)
At the time of writing (Spin v3.1.2), the `Os` enum is [defined][0] as follows:
```rs
enum Os {
Linux,
Macos,
Windows,
}
```
This commit adjust the SIP to match the implementation by renaming `osx` to `macos`. Note that the SIP later on uses `macos` as part of the URL in one of the examples.
[0]: https://github.com/fermyon/spin/blob/v3.1.2/crates/plugins/src/manifest.rs#L113
Signed-off-by: Petar Kirov <[email protected]>
itowlson
approved these changes
Feb 12, 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.
At the time of writing (Spin v3.1.2), the
Osenum is defined as follows:This commit adjust the SIP to match the implementation by renaming
osxtomacos. Note that the SIP later on usesmacosas part of the URL in one of the examples.Background
Our team is using the Nix to package (build from source and "install") a Spin plugin that we developed. In process we created a Nix function to generate the spin plugin manifest file by compiling the source code, archiving and hashing it and filling the rest of manifest fields, following the SIP006 spec. Specifically, we were mapping Nix kernel name to spin plugin package
oslike so:Testing on macOS immediately highlighted the problem: