Repository navigation
Enable spec publishing to NPM - #25
Merged
Merged
Conversation
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The remaining README clarification is a minor, non-blocking nit.
Review effort: Lite
Findings: None
What changed in this PR
Adds a spec-only NPM package for distributing the canonical OpenCLI JSON Schema.
Changes:
- Adds package metadata, exports, and documentation.
- Adds tag-triggered validation and publishing workflow.
- Includes the schema and license in the published package.
| File | Summary |
|---|---|
npm/specification/README.md |
Documents installation and schema usage; clarify prerelease dist-tag usage. |
npm/specification/package.json.tmpl |
Defines package metadata and exports. |
.github/workflows/npm-publish-specification.yaml |
Validates versions, prepares contents, and publishes the package. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
publish a spec-only package to NPM to support downstream packages that rely on the OpenCLI specification. On publish, the canonical spec is copied from the root of the opencli repo to the npm/specification package directory. The version of the package is determined by the git tag that triggers the workflow (and verified to match the version within the JSON schema)
Published NPM packages for OpenCLI can be found at: https://www.npmjs.com/package/@openclidev/specification