Add CI workflow to publish javascript packages (#707)

* workflows

* try private

* private

* more private

* update files

* fix workflow

* hm

* hm

* bump version

* bump version

* another bump

* text

* update readme

* update package lock

Author: jayantk

.github/workflows/publish-js.yml

@@ -0,0 +1,21 @@
+name: Publish Pyth JS packages
+
+on:
+  release:
+    types:
+      - created
+jobs:
+  publish-solidity-sdk:
+    name: Publish Javascript Packages to NPM
+    if: ${{ startsWith(github.ref, 'refs/tags/pyth-js-v') }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: "16"
+          registry-url: "https://registry.npmjs.org"
+      - run: npm ci
+      - run: npx lerna publish from-package --no-git-tag-version
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

@@ -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
 

governance/multisig_wh_message_builder/package.json

@@ -3,6 +3,7 @@
   "version": "0.1.0",
   "description": "Pyth Multisig Wormhole Message Builder",
   "homepage": "https://pyth.network",
+  "private": "true",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [

governance/xc_admin/packages/crank_executor/package.json

@@ -2,6 +2,7 @@
   "name": "crank_executor",
   "version": "0.0.0",
   "description": "A crank to executed all executeReady multisig transaction",
+  "private": "true",
   "author": "",
   "homepage": "https://github.com/pyth-network/pyth-crosschain",
   "license": "ISC",

governance/xc_admin/packages/crank_pythnet_relayer/package.json

@@ -2,6 +2,7 @@
   "name": "crank_pythnet_relayer",
   "version": "0.0.0",
   "description": "A crank to relay pyth governance actions to pythnet",
+  "private": "true",
   "author": "",
   "homepage": "https://github.com/pyth-network/pyth-crosschain",
   "license": "ISC",

governance/xc_admin/packages/xc_admin_cli/package.json

@@ -1,6 +1,7 @@
 {
   "name": "xc_admin_cli",
   "version": "0.0.0",
+  "private": "true",
   "description": "",
   "author": "",
   "homepage": "https://github.com/pyth-network/pyth-crosschain",

governance/xc_admin/packages/xc_admin_common/package.json

@@ -2,6 +2,7 @@
   "name": "xc_admin_common",
   "version": "0.0.0",
   "description": "",
+  "private": "true",
   "author": "",
   "homepage": "https://github.com/pyth-network/pyth-crosschain",
   "license": "ISC",

governance/xc_governance_sdk_js/package.json

@@ -2,6 +2,7 @@
   "name": "@pythnetwork/xc-governance-sdk",
   "version": "0.2.0",
   "description": "Pyth Cross-chain Governance SDK",
+  "private": "true",
   "homepage": "https://pyth.network",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",