chore(package): carry the author URL and publishConfig, and state the metadata the npm page reads - #19
Merged
Merged
Conversation
… metadata the npm page reads The npm page showed a bare author string and the publish access and provenance lived only in the workflow's flags, so a publish from any other path would have carried neither, and nothing said which package.json fields a release keeps. author is now an object with the URL, publishConfig fixes public access and provenance in the package itself, the README carries the CI badge beside the version and license badges, and RELEASING.md lists the field set the npm page reads and the tarball check CI already runs.
There was a problem hiding this comment.
Pull request overview
This PR updates npm-facing package metadata and release documentation so releases consistently publish with the intended author/publish settings and the repository clearly documents which package.json fields are expected to appear on the npm package page.
Changes:
- Update
package.jsonto use an object-formauthor(including URL) and addpublishConfigto enforceaccess: publicandprovenance: true. - Add a CI badge to the README header so the npm page shows build status alongside version/license.
- Expand
RELEASING.mdto document the package metadata fields that are expected to be present and to reference the existing packaging/tarball verification test.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| RELEASING.md | Documents the expected npm/package metadata field set and ties releases to the existing tarball verification test. |
| README.md | Adds a CI status badge to improve npm page presentation. |
| package.json | Carries structured author metadata and publishConfig so publishing behavior is encoded in the package itself. |
💡 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.
Why
The npm page showed a bare
authorstring, and publish access and provenance lived only in the workflow's flags, so a publish from any other path would have carried neither; nothing said whichpackage.jsonfields a release keeps.authoris now an object with the URL,publishConfigfixes public access and provenance in the package itself, the README carries the CI badge beside the version and license badges, andRELEASING.mdlists the field set the npm page reads and the tarball check CI already runs (test/packaging.test.ts).Validation
package.jsonparses with the new fields; CI runs the packaging test on this PR. No publish happens here; the fields take effect on the next release cut through the checklist.