Repository navigation
build(plugins-sdk): prepare local npm publication - #3704
parkerlandon-codaio wants to merge 4 commits into
Conversation
Preserve the current version, changelog history, SDK APIs, and CLI commands. Add a standalone interactive first-publish path and repair legacy imports in copied starters. Refs GOECOS-722.
GOECOS-722 Verify and publish @superhuman/plugins-sdk on npm
ScopePublish the SDK exported to Coordinate release ownership with Publish SDK out of FEWM. First complete GOECOS-773 to identify the Acceptance criteria
Requires successful export verification in GOECOS-505. Optional Connector aliases in GOECOS-506 are not a prerequisite. Old-package retirement is separate in GOECOS-723. ReferencesRelated implementation PR
|
Wiz Scan Summary
To detect these findings earlier in the dev lifecycle, try the Wiz Code extension for VS Code, JetBrains, or Visual Studio. |
Retain only the package metadata, standalone release-it configuration, and workspace alias needed to keep existing samples building. Restore documentation, changelog, SDK/CLI code, generated files, Makefile, and workflow changes. Refs GOECOS-722.
@superhuman/plugins-sdkPreserve the new package name and local release-it setup while taking version 1.18.4 and all release changes from main.
Prepare the first local npm release as
@superhuman/plugins-sdk, retaining version1.18.4and the existing changelog.The change is limited to four files:
package.json: set the npm name and public registry..github/releases/first-publish.config.cjs: stage the current version through release-it for separate approval, without creating Git commits/tags/pushes or GitHub releases.documentation/samples/package.jsonandpnpm-lock.yaml: keep existing sample imports working through a local workspace alias after the package name changes.Documentation content, examples, SDK/CLI code, generated files, changelog, Makefile, and CI workflows are unchanged.
Use an npm version supporting staged publication, such as npm 11.15.0 pinned in CI. From an updated, clean
maincheckout with the supported Node version and dependencies installed:The last command submits a stage; it does not make the package public. Release-it prints the stage approval command. Inspect the stage, then publish it separately with npm 2FA:
For the feature branch, explicitly override the config's main-only check with
--git.requireBranch=parkerlandon-superhuman-npm-publication. Authentication uses the local npm login; no separately minted automation token is needed. Nothing has been staged or published by this PR.Validation: frozen pnpm install, full build, sample validation, and packed artifact inspection passed after merging main's 1.18.4 release. The staging change passed an isolated release-it fixture with network blocked: it runs
npm stage publish, prints the approval command, never directly publishes or approves, preserves version/changelog/Git state, and retains authentication/branch checks.skip-version-checkpreserves the requested existing version.Refs GOECOS-722. Internal source/export alignment remains separate coordination before publication.