Release 2.2.0-beta.1

.github/workflows/base-coverage.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - fdc3-for-web-impl
 
 jobs:
   test_and_upload_coverage:

.github/workflows/package.yml

@@ -145,6 +145,6 @@ jobs:
 
     - name: Publish
       if: steps.check-version.outputs.exists == '0' 
-      run:  npm publish --provenance --access public
+      run:  npm publish --provenance --access public --workspaces
       env:
         NODE_AUTH_TOKEN: ${{ secrets[matrix.token-name] }}

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [npm v2.2.0-beta.1] - 2024-02-25
+
+* Prerelease of NPM 2.2.0 module
+
 ## [Unreleased]
 
 ### Added
@@ -29,6 +33,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added the ability to control logging to the JS console from getAgent() and the DesktopAgentProxy via arguments to getAgent(). ([#1495](https://github.com/finos/FDC3/pull/1495))
 * Added the ability for a browser-based DesktopAgent to control the timeouts used in the DesktopAgentProxy when making calls to it, via properties in WCP3Handshake message. ([#1497](https://github.com/finos/FDC3/pull/1497))
 * Added .NET docs for Events to API reference. ([#1441](https://github.com/finos/FDC3/pull/1441))
+* Setup package publishing for mono-repo packages. ([#1520](https://github.com/finos/FDC3/pull/1520))
 
 ### Changed
 
@@ -58,6 +63,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Added missing id and name fields from the context base schema to respective context schemas (`Contact`, `ContactList`, `Country`, `InstrumentList`, `OrderList`, `Organization`, `Portfolio`, `Position`, `TradeList`). ([#1360](https://github.com/finos/FDC3/pull/1360))
 * Revised FDC3 charter to include well-known language from the FDC3 introduction, better describe FDC3's scope, focus on financial applications, update application types, etc. ([#1079](https://github.com/finos/FDC3/pull/1079))
 * Ensured that `PrivateChannelEvent` extends `ApiEvent` in both sourcecode and documentation. ([#1474](https://github.com/finos/FDC3/pull/1474))
+* Standardized prettier config for fdc3-workbench with other packages. ([#1520](https://github.com/finos/FDC3/pull/1520))
 
 ## [npm v2.1.1] - 2024-06-28
 

README.md

@@ -103,19 +103,56 @@ From the root package, you can run `npm run build` to build all the modules, or
 
 For installation and usage instructions, see: <https://fdc3.finos.org/docs/supported-platforms#usage>
 
-### Bumping Version Numbers (for maintainers)
-
-It's important that all of the versions of the submodules stay on the same version, and that the references between them are consistent to that version.  To change the version number (say before or after a release) run the following:
-
-```
-// first, update version number in package.json
-npm login
-npm version <new version from package.json> --workspaces // changes the version number in all submodule package.json files
-npm run syncpack                          // sycnhronizes version numbers
-npm up                                    // fixes node_module references
-npm run build                             // builds all the modules against the new version
-npm publish --access=public --workspaces  // this step performs a manual release of the npm modules (not needed with GitHub actions releases)
-```
+### Releasing FDC3 to NPM (for maintainers)
+
+This is a 4-step process:
+
+1.  **Create a release branch**
+
+  Do this locally.  Ensure the branch is named `release/v2.0` (or whatever the next version is).
+
+  ```bash
+  git checkout -b release/v2.0
+  ```
+
+2.  **Update the version numbers in the package.json files**
+
+  It's important that all of the versions of the submodules stay on the same version, and that the references between them are consistent to that version.  To change the version number (say before or after a release) run the following:
+
+  ```bash
+  // first, update version number in package.json
+  npm login
+  npm version <new version from package.json> --workspaces // changes the version number in all submodule package.json files
+  npm run syncpack                          // sycnhronizes version numbers
+  npm up                                    // fixes node_module references
+  npm run build                             // builds all the modules against the new version
+  ```
+
+3.  **Push the branch to publish the packages to npm**
+
+  ```bash
+  git push origin release/v2.0
+  ```
+
+  This should trigger a GitHub action that will publish the packages to npm.
+
+4.  **Create a PR for merging the release branch.**
+
+  Once the packages are published, create a PR to merge the release branch into the main branch.  You will need other FDC3 maintainers to review and approve the PR.
+
+5.  **Reset the `latest` NPM Version Tag If Releasing A Prerelease**
+
+  If you're releasing beta/alpha code, be sure to replace the latest version in NPM like so:
+
+  ```
+  npm dist-tag add @finos/fdc3@2.1.1 latest
+  ```
+
+  You will need support from help@finos.org for this step.
+
+### Releasing the FDC3 Website (for maintainers)
+
+Please see instructions in the [website README](./website/README.md).
 
 ## Getting Involved