Release workflow setup via GH actions (#222)

* chore: release workflow

* docs: add RELEASE.md

Author: viglucci

.github/workflows/build.yml

@@ -1,6 +1,7 @@
 name: Build
 
 on:
+  workflow_dispatch:
   push:
   pull_request:
     branches: [ $default-branch ]

.github/workflows/release.yml

@@ -1,7 +1,13 @@
-name: Release
+name: Test, Build, Release
 
 on:
   workflow_dispatch:
+    inputs:
+      shouldPublish:
+        description: 'Publish'
+        required: true
+        default: true
+        type: boolean
 
 jobs:
   lint:
@@ -64,7 +70,11 @@ jobs:
       - name: Test
         run: yarn test
 
-  compile:
+  compile_publish:
+    needs:
+      - lint
+      - test
+
     runs-on: ubuntu-latest
 
     steps:
@@ -94,25 +104,14 @@ jobs:
       - name: Compile
         run: yarn build
 
-  publish:
-    needs:
-      - lint
-      - test
-      - compile
-    runs-on: ubuntu-latest
-    steps:
-      - name: Set Git Identity
-        run: |
-          git config --global user.name 'github-actions[bot]'
-          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
-          git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/$GITHUB_REPOSITORY
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: fregante/setup-git-user@v1
 
       - name: Set NPM Token
         run: echo //registry.npmjs.org/:_authToken=${NPM_TOKEN} > .npmrc
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Publish
-        run: yarn lerna publish from-package --yes
+        if: ${{ github.event.inputs.shouldPublish == 'true' }}
+        run: yarn lerna publish from-package --yes --no-verify-access
+

RELEASE.md

@@ -0,0 +1,23 @@
+# Release
+
+How to publish new releases for this project.
+
+## Versioning
+
+[semver](https://semver.org/) should be followed when deciding new release versions.
+
+You can either set versions in the `package.json` files manually, or use the `lerna version` command to set them via the Lerna CLI. When setting versions manually, you will also need to set the git tags for each package and version.  For this reason, it is recommended you use the `lerna version` command, which will create these tags automatically.
+
+ex: `@rsocket/adapter-rxjs@1.0.0-alpha.1`
+
+Lerna will not push the git tags after creation. You should push the git tags once you are confident in your changes.
+
+## Publishing
+
+The `Test, Build, Release` Workflow on GitHub can be run to [manually trigger](https://docs.github.com/en/actions/managing-workflow-runs/manually-running-a-workflow) publishing of packages to NPM. This workflow will only publish versions which do not already exist on NPM.
+
+The `Test, Build, Release` Workflow will:
+
+- Run automated linting & tests
+- Compile/build various packages
+- Publish built packages to NPM

packages/rsocket-adapter-rxjs/package.json

@@ -6,6 +6,9 @@
   "files": [
     "dist"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rimraf -rf ./dist",

packages/rsocket-composite-metadata/package.json

@@ -6,6 +6,9 @@
   "files": [
     "dist"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rimraf -rf ./dist",

packages/rsocket-core/package.json

@@ -6,6 +6,9 @@
   "files": [
     "dist"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rimraf -rf ./dist",

packages/rsocket-examples/src/rxjs/ClientServerCompositeMetadataRouteExample.ts

@@ -15,8 +15,15 @@
  */
 
 import { RSocketConnector, RSocketServer } from "rsocket-core";
-import { Codec, RSocketRequester, RSocketResponder } from "rsocket-messaging";
-import { RxRequestersFactory, RxRespondersFactory } from "rsocket-adapter-rxjs";
+import {
+  Codec,
+  RSocketRequester,
+  RSocketResponder,
+} from "rsocket-messaging";
+import {
+  RxRequestersFactory,
+  RxRespondersFactory,
+} from "rsocket-adapter-rxjs";
 import { TcpClientTransport } from "rsocket-transport-tcp-client";
 import { TcpServerTransport } from "rsocket-transport-tcp-server";
 import { exit } from "process";

packages/rsocket-messaging/package.json

@@ -6,6 +6,9 @@
   "files": [
     "dist"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rimraf -rf ./dist",

packages/rsocket-tcp-client/package.json

@@ -6,6 +6,9 @@
   "files": [
     "dist"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "build": "yarn run clean && yarn run compile",
     "clean": "rimraf -rf ./dist",

packages/rsocket-tcp-client/src/__tests__/TcpClientTransport.spec.ts

@@ -3,7 +3,11 @@ import { TcpDuplexConnection } from "../TcpDuplexConnection";
 import * as net from "net";
 import sinon from "sinon";
 import EventEmitter from "events";
-import { Demultiplexer, FrameHandler, Multiplexer } from "rsocket-core/src";
+import {
+  Demultiplexer,
+  FrameHandler,
+  Multiplexer,
+} from "rsocket-core/src";
 import { mock } from "jest-mock-extended";
 
 describe("TcpClientTransport", function () {