Add instructions on how to publish the packages

koesie10 · Oct 22, 2022 · ebea481 · ebea481
1 parent e5d4c6e
commit ebea481
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -35,8 +35,7 @@ jobs:
           CHILD_CONCURRENCY: 1
       - name: Bootstrap Lerna
         run: yarn lerna bootstrap
-      - name: Version and publish
-        run: |
-          yarn lerna publish from-git --yes
+      - name: Publish
+        run: yarn lerna publish from-git --yes
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/README.md b/README.md
@@ -101,6 +101,12 @@ Distributed under the MIT license. See ``LICENSE`` for more information.
 4. Push to the branch (`git push origin feature/fooBar`)
 5. Create a new Pull Request
 
+## Publishing a new version
+
+1. Run `yarn lerna version` to bump the version of all packages
+2. Create a release on GitHub with the new version number
+3. GitHub Actions will automatically publish the new version to NPM
+
 <!-- Markdown link & img dfn's -->
 [fsuipc-npm-image]: https://img.shields.io/npm/v/fsuipc.svg?style=flat-square
 [fsuipc-npm-url]: https://npmjs.org/package/fsuipc