Skip to main content

Synapse NPM Packages Are Moving to GitHub Packages

ยท One min read

All @synapsecns packages are now published to GitHub Packages instead of the npm registry.

What Changedโ€‹

We've migrated our package registry from npm to GitHub Packages. This affects the following packages:

  • @synapsecns/sdk-router
  • @synapsecns/synapse-constants
  • @synapsecns/contracts-core
  • @synapsecns/solidity-devops
  • @synapsecns/coverage-aggregator
  • @synapsecns/widget

How to Update Your Projectโ€‹

To install @synapsecns packages from GitHub Packages, add a .npmrc file to the root of your project (next to your package.json):

@synapsecns:registry=https://npm.pkg.github.com

Then install packages as usual:

npm install @synapsecns/sdk-router
# or
yarn add @synapsecns/sdk-router

GitHub Packages requires authentication even for public packages. You can authenticate by adding your GitHub personal access token (with read:packages scope) to your .npmrc:

//npm.pkg.github.com/:_authToken=YOUR_GITHUB_TOKEN

Or set the environment variable:

export NPM_TOKEN=YOUR_GITHUB_TOKEN

Why the Moveโ€‹

This migration consolidates our release infrastructure under GitHub, simplifying CI/CD and aligning package publishing with the repository where development happens.

Existing versions already published on the npm registry will remain available. All new versions will be published exclusively to GitHub Packages.

If you have any questions, feel free to open an issue on GitHub.