chore(package): carry the author URL and publishConfig, and state the metadata the npm page reads - #24
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 tightens published npm package metadata and documents what release artifacts/fields are expected, so releases consistently carry the same npm-facing information regardless of publish path.
Changes:
- Updated
package.jsonto use an objectauthor(with URL) and addedpublishConfig(access: public,provenance: true). - Added a CI badge to the README header alongside existing npm version and license badges.
- Expanded
RELEASING.mdwith a “Package metadata” section and noted the packaging CI check during the release checklist.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| RELEASING.md | Documents which package.json fields/releases should preserve and references the CI packaging/tarball check. |
| README.md | Adds CI badge so the npm-rendered README shows build status near other key badges. |
| package.json | Ensures npm metadata includes author URL and enforces publish access/provenance via publishConfig. |
💡 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.