feat: prep npm release — activate publish workflow, add registry metadata#2
Merged
Conversation
…data — 0.1.4 Un-dormants release.yml now that the zoldytech npm org exists: enables OIDC-based `npm publish --provenance`, and creates the GitHub Release only after publish succeeds (so a failed publish can never leave a tag/release with no matching npm version). Adds package.json registry metadata (publishConfig, repository, homepage, bugs) and drops `private: true`. Updates README to the real npm install command and adds npm/CI badges. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Prepares this package for an npm registry release by enabling an OIDC-based publish workflow, updating package.json with publish-ready metadata, and aligning the README with npm-based installation and status badges.
Changes:
- Activated
release.ymlto publish to npm with provenance and create a GitHub Release afterward. - Updated
package.jsonfor public publishing (removedprivate, addedpublishConfig, repo/homepage/bugs metadata) and bumped version0.1.3→0.1.4. - Updated README with npm install command and added npm/CI badges.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Adds npm/CI badges and switches install instructions to npm i -D @zoldytech/javascript. |
| package.json | Adds npm registry metadata, enables public publishing, and bumps package version. |
| .github/workflows/release.yml | Re-enables release workflow to publish via OIDC provenance and create a GitHub Release post-publish. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Addresses Copilot review on #2: contents:write wasn't needed for npm publish itself; the tag-vs-package.json version gate was documented but never enforced; and a failed `gh release create` after a successful publish had no clean retry path (rerunning the job would rerun npm publish, which fails on an already-published version). Splitting into publish -> release jobs fixes all three, and lets the release job be rerun independently. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Member
Author
|
Addressed both Copilot findings in e8b6a10:
|
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.
Summary
release.yml: enables OIDC-basednpm publish --provenance(noNPM_TOKENsecret), and creates the GitHub Release after publish succeeds so a failed publish can never leave a tag/release with no matching npm version.package.jsonmetadata: dropsprivate: true, addspublishConfig.access: public,repository,homepage,bugs. Bumps version0.1.3->0.1.4.npm i -D @zoldytech/javascriptinstall command (replacing the GitHub-URL-pinned-tag install), adds npm version/downloads + CI badges.Context
Prompted by creating the
zoldytechnpm org and auditing this repo's CI/release setup againsta-tokyo/apple-signin-auth. That repo creates its GitHub Release beforenpm publish, and itsNPM_TOKENhas been silently expired for over a month — its latest release has no matching npm version with no alerting. This PR sequences the opposite way (publish first, release second) so that failure mode can't happen here.Prerequisite (not part of this PR)
Before the first tag push will actually publish, OIDC trusted publishing needs to be enabled on npmjs.com for this package: Settings -> Trusted Publisher -> GitHub Actions ->
Zoldytech/javascript->release.yml.Test plan
npm run lintpassesnpm testpasses (22/22)release.ymlYAML validatedv0.1.4and confirm the release workflow publishes to npm and creates a GitHub Release0.1.1,0.1.2,0.1.3(tracked separately, not in this PR)