ci: add npm publish workflow and scoped package metadata - #1
Merged
Conversation
…itory and bugs information, and include prepublish script
… contributors, and enhance usage instructions for Cursor MCP configuration.
…rely on package.json for version management.
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.
Description
This branch prepares
@fqueis/openapi-contractfor public npm distribution. It adds a GitHub Actions publish workflow (OIDC trusted publishing), updatespackage.jsonfor the scoped package name and publish metadata, and refreshes the README so consumers can install and run the server vianpxfrom npm.Key Changes & Features Implemented
CI / Publishing
Publishworkflow onmain(andworkflow_dispatch) that skips when the version is already on npm, then runs lint/test/build, creates a GitHub Release, and publishes with npm trusted publishing (OIDC). (4c1ac84)Package metadata
@fqueis/openapi-contract, set author/homepage/repository/bugs, add publicpublishConfig, and runpnpm run buildviaprepublishOnly. (da842ea)Documentation
npx -y @fqueis/openapi-contract, clarify that pnpm is for contributors, and keep local built-JS setup under local development. (0b5268b)How to Test
package.jsonname is@fqueis/openapi-contract, version is1.0.0, andpublishConfig.accessispublic..github/workflows/publish.ymlforid-token: write, Node22.14, the already-published gate, and the lint → test → build → release → publish path.pnpm lint,pnpm test, andpnpm buildlocally to match the workflow gates.npxwith@fqueis/openapi-contract, and that local contributor steps still documentpnpmbuild/test.mainor useworkflow_dispatchand confirm the workflow publishes or correctly skips an already-published version.