From 4bf80e06fc34d589436476ad87ea134204d1d624 Mon Sep 17 00:00:00 2001
From: Brandon Wood <woodb@users.noreply.github.com>
Date: Fri, 25 Feb 2022 16:49:55 -0500
Subject: [PATCH] build: add dev publish commands, docs (#1010)

* build: add dev publish commands, docs

* docs: fix typo
---
 CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++
 package.json    |  1 +
 2 files changed, 32 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4e4965f6b..6f86cde00 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -55,3 +55,34 @@ The monorepo has a top level `lint` command which runs lint for all the packages
 ## Build a `starter-kyt`
 
 Have a great idea for a boilerplate? Build it on top of `kyt` and let us know about it. Directions are [here](/docs/Starterkyts.md).
+
+## Publishing to `npm`
+
+!!! warning You _must_ use `npm` to publish, rather than `yarn`.
+
+In order to publish to `npm`, you _must_ use `npm` to publish (instead of
+`yarn`). In order for the various command line utilities that are used to work,
+you must publish using the provided `publish` script in `package.json`.
+
+This can be accomplished with the following command:
+
+```sh
+$ GH_TOKEN=$GITHUB_TOKEN npm run publish
+```
+
+For more information on using `lerna` to publish, see [the `lerna publish`
+documentation](https://github.com/lerna/lerna/tree/main/commands/publish#readme).
+
+### Development Versions
+
+If you would like your prerelease to have the `next` dist tag, rather than
+`latest`, such as when creating a release candidate or testing a development
+version, you can use the provided `publish:next` script.
+
+```sh
+$ GH_TOKEN=$GITHUB_TOKEN npm run publish:next
+```
+
+If you need more functionality than this, it is recommended that you pass your
+own parameters to the `npm run publish` command, that will be included in the
+flags/arguments to the `lerna publish` command.
diff --git a/package.json b/package.json
index d5a2f9474..8c24e9824 100644
--- a/package.json
+++ b/package.json
@@ -19,6 +19,7 @@
     "bootstrap:ci": "yarn && lerna run prepare",
     "clean-bootstrap": "lerna clean --yes && rm -rf node_modules && yarn bootstrap",
     "publish": "lerna publish",
+    "publish:next": "lerna publish --preid next --dist-tag next",
     "test:starter": "lerna exec --scope \"kyt-starter-{server,static,universal}-src\" --",
     "test": "lerna run prepare && jest --detectOpenHandles && yarn test:starter yarn test --detectOpenHandles",
     "test:ci": "jest --detectOpenHandles --ci && yarn test:starter yarn test --detectOpenHandles --ci",