Repository navigation
chore(packages): publish the SDK and CLI to GitHub Packages - #217
Conversation
Both packages are to become internal to Aignostics. The release workflow now publishes them to the aignostics organisation's npm registry on GitHub Packages with the workflow's GITHUB_TOKEN, and the repository's .npmrc maps the @aignostics scope there. The READMEs explain how to authenticate for installs. Refs: TSSDK-85 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
OX Security reviewed this pull request — nothing to fix.
Branch |
|
There was a problem hiding this comment.
🔵 Needs a closer look
The registry migration requires human confirmation that both private packages grant this repository’s Actions write access and that an authenticated consumer can install the released CLI and resolve its SDK dependency.
No open issues 🎉
What changed in this PR
Moves future SDK and CLI releases from npmjs.com to GitHub Packages as the first step toward internal distribution. Consumer migration, npm deprecation, and repository visibility changes remain separate work.
Changes:
- Updates publishing jobs to use GitHub Packages with
GITHUB_TOKENand package-write permissions. - Sets restricted publishing, repository metadata, and the scoped registry configuration.
- Documents authenticated installation and updates the architecture’s distribution channel.
| File | Description |
|---|---|
README.md |
Adds registry and token setup instructions. |
packages/sdk/README.md |
Links SDK installation to registry setup. |
packages/sdk/package.json |
Configures restricted GitHub Packages publishing and repository linkage. |
packages/cli/README.md |
Links CLI installation to registry setup. |
packages/cli/package.json |
Configures restricted GitHub Packages publishing and repository linkage. |
docs/SOFTWARE_ARCHITECTURE.md |
Documents GitHub Packages as the distribution channel. |
.npmrc |
Routes the @aignostics scope to GitHub Packages. |
.github/workflows/release-please.yml |
Switches both publishing jobs to GitHub Packages authentication and permissions. |
Review effort: Balanced
|
Written on behalf of tobi-ax by Claude Opus 5.5 On Copilot's two open points: Consumer install. In an empty project whose only config is Actions write access. It can only be confirmed by the first publish. Both packages were created by this repository's own workflow with |



Jira: TSSDK-85, part of TSSDK-83
The release workflow publishes
@aignostics/sdkand@aignostics/clito the aignostics organisation's npm registry on GitHub Packages instead of npmjs.com. This is the first step of making both packages internal. Moving the consumers, deprecating the npm packages and switching the repository to internal come in their own PRs.Both packages already exist on GitHub Packages as private packages linked to this repository. This workflow published them there with
GITHUB_TOKENuntil August 2025, and Portal installs SDK 3.8.1 from there today. Release PR #196 (cli 4.1.0) will be the first release through the new path.Changes
release-please.yml:publish-sdkandpublish-clipointsetup-nodeathttps://npm.pkg.github.comwith the@aignosticsscope, getpackages: write, and publish withGITHUB_TOKEN. Nothing in the workflow readsNPM_TOKENany more.packages/{sdk,cli}/package.json:publishConfignames GitHub Packages withrestrictedaccess. Arepositoryfield withdirectorykeeps the packages linked to this repository..npmrc: maps@aignosticsto GitHub Packages, like Portal, HETA Studio and web-wsi-viewer. Every@aignosticsdependency here is a workspace link, sonpm cineeds no token.README.mdand both package READMEs: how to set up the registry and aread:packagestoken for installs.docs/SOFTWARE_ARCHITECTURE.md: GitHub Packages replaces the public npm registry as the distribution channel.Testing
npm ciwith an empty user.npmrc(no GitHub token) succeeds, so the test jobs are unaffected.npm publish --dry-runin both packages reportsPublishing to https://npm.pkg.github.com/ with tag latest and restricted access.use-trusted-publishingnotes as onmain. npm trusted publishing applies only to npmjs.com.The real test is the first release after merge. If GitHub Packages rejects the publish with 403, the package settings have to grant this repository write access under "Manage Actions access".
🤖 Generated with Claude Code