Procedure: Creating Releases - dsriseah/ursys GitHub Wiki

URSYS is not released to the npm registry. It's installed from this github repo.

Prepare

First make a list of changes you've made since the last release. The list of releases are at https://github.com/dsriseah/ursys/releases

Then update package.json version number appropriate.

Next you need to run the following command from the CLI

ur package

This updates the distribution files which are loaded from a particular tag or branch (e.g. core-node.cjs)

Now you can push the changes upstream.

Create Release

On github, click on the RELEASES on the right side of the screen.

Create a new release and make a new dated tag. Here's a template:

This release provides

[high level summary]

To install/update this release in your projects, use `npm install dsriseah/ursys#2025-1014`

## CHANGELOG

[list of changes]

**Full Changelog**: https://github.com/dsriseah/ursys/compare/2025-0422...2025-1014

Test New Release

Update your package.json with the latest tag then npm install. Then run code that will tell you if the package has been updated (check version number, also check features).

In the case that the library isn't updating, you may have to update the caches. There are four possible ones:

  • rm -fr node_modules package-lock.json to remove local project copies of the modules and package hashes
  • npm cache clean --force will remove the global npm cache
  • rm -rf ~/.npm/_cacache/tmp will remove cached github-sourced packages (this is the one you probably want)

After that you can do npm install again and see if it fixes it. The ursys and example packages often have this force-clean run script.