PixelStreamingInfrastructure/RELEASING.md

Cutting releases

There are multiple things in this repository that can be released:

• The signalling server container image
• The /library NPM package
• The /ui-library NPM package
• The entire repo and built frontend as a Github release .zip/tar.gz archive

Signalling Server Container

1. Switch to the target branch (e.g 5.2)
2. Make/merge any changes into /SignallingWebServer directory
3. This will automatically kick off a this action for a build+push of the signalling server container image.

The /library NPM package

1. Switch to the target branch (e.g 5.2)
2. Make/merge any changes into /library directory
3. Based on the changes made, bump the version number according to semver in the package.json file
4. Commit the changes to the package.json file.
5. This will automatically kick off a this action for a build+push to NPM.

The ui-library NPM package

1. Switch to the target branch (e.g 5.2)
2. Make/merge any changes into /ui-library directory
3. Based on the changes made, bump the version number according to semver in the package.json file
4. Optional: Update the version of the core library in the package.json if it got bumped (here & here).
5. Commit the changes to package.json and potentially the package-lock.json file.
6. This will automatically kick off a this action for a build+push to NPM.

The Github releases archives

1. Switch to the target branch (e.g 5.2)
2. Make/merge any changes anywhere in the repo.
3. Based on the changes made, bump the version number according to semver in the RELEASE_VERSION file.
4. Commit the changes to RELEASE_VERSION file.
5. This will automatically kick off a this action for tagged Github release with .zip and .tar.gz archives.

Handling multiple changes

If multiple changes have been made, the order of releases should usually be like so:

1. /library
2. /ui-library
3. RELEASE_VERSION file