docs: add documentation for publishing new packages (#236)

awslabs · Oct 17, 2022 · e23d2e3 · e23d2e3
1 parent e43f5b7
commit e23d2e3
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 7 deletions.
diff --git a/docs/CodingGuidelines.md b/docs/CodingGuidelines.md
@@ -6,11 +6,14 @@ Guidelines that code authors and code reviewers are expected to adhere to in the
 
 ## Table of contents
 
-- [Components](#components)
-- [Code Style](#code-style)
-- [Documentation](#documentation)
-- [Pull Requests](#pull-requests)
-- [Tests](#tests)
+- [Coding guidelines](#coding-guidelines)
+  - [Table of contents](#table-of-contents)
+  - [Components](#components)
+  - [Code style](#code-style)
+  - [Documentation](#documentation)
+  - [Pull requests](#pull-requests)
+  - [Tests](#tests)
+  - [Packages](#packages)
 
 ---
 
@@ -214,4 +217,16 @@ Guidelines that code authors and code reviewers are expected to adhere to in the
    it(“button dispatches onClick event”)
    ```
 
-- Tests should, at minimum, cover all core feature use-cases and identifiable edge-cases or boundary conditions.
+- Tests should, at minimum, cover all core feature use-cases and identifiable edge-cases or boundary conditions.
+
+## Packages
+
+- Packages in the monorepo each represent a publishable, standalone functionality.
+- To ensure new packages are published to NPM, add a corresponding GitHub action step to `.github/workflows/npm-publish.yml`.
+```
+      - name: Publish {MY PACKAGE NAME}
+        uses: JS-DevTools/npm-publish@v1
+        with:
+          package: './packages/{MY PACKAGE PATH}/package.json'
+          token: ${{ secrets.NPM_TOKEN }}
+```
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
   "repository": "git@github.com:awslabs/iot-app-kit.git",
   "engines": {
     "node": ">=16.0.0",
-    "npm": ">=8.0.0"
+    "npm": ">=8.5.0"
   },
   "workspaces": {
     "packages": [