|
|
@@ -47,7 +47,16 @@ and examples for your blockchain runtime in the `target_chains` directory.
|
|
|
|
|
|
### Releases
|
|
|
|
|
|
-We use [Semantic Versioning](https://semver.org/) for our releases.
|
|
|
+The repository has a CI workflow that will release javascript packages whose version number has changed.
|
|
|
+To perform a release, follow these steps:
|
|
|
+
|
|
|
+1. Update the version number in the `package.json` file for the package(s) you wish to release. Please follow [Semantic Versioning](https://semver.org/) for package versions.
|
|
|
+2. Submit a PR with the changes and merge them in to main.
|
|
|
+3. Create a new release in github with a tag of the form `pyth-js-v<number>`. You can simply increment the version number each time -- it doesn't affect any of the published information.
|
|
|
+4. When this release is published, it will automatically trigger a CI workflow to publish the updated packages to NPM.
|
|
|
+
|
|
|
+If you have a javascript package that shouldn't be published, simply add `"private": "true"` to the `package.json` file
|
|
|
+and it will be excluded from the publishing workflow.
|
|
|
|
|
|
### pre-commit hooks
|
|
|
|