Merge pull request #47 from MetroStar/CSG-632

CSG-632: Final Cleanup/Review of Comet Projects

CONTRIBUTING.md

@@ -41,11 +41,6 @@ npm run lint
 npm run format
 ```
 
-## Publishing to NPM
+## Releasing packages
 
-To publish a package to NPM, run the following:
-
-```sh
-npm run build:[SOME PACKAGE]
-npm publish
-```
+See the following for creating a new release: [Releasing](https://github.com/MetroStar/comet/blob/main/RELEASING.md)

README.md

@@ -1,4 +1,10 @@
-# Comet
+<p style="text-align: center;">
+  <picture>
+    <img alt="Comet Component Library" src="https://raw.githubusercontent.com/MetroStar/comet/main/images/comet-logo.png" width="100%">
+  </picture>
+</p>
+
+<br/>
 
 Comet is a React with TypeScript Component Library based on USWDS.
 

RELEASING.md

@@ -0,0 +1,37 @@
+# Releasing new versions of packages
+
+Note: currently full releases are tied to the main `comet-uswds` package.
+
+## Releasing a new version of comet-uswds
+
+1. Create a new release branch in the form of `comet-uswds-release-[MAJOR.MINOR.PATCH]`
+2. Create a PR into main (should only include package.json and package-lock.json)
+3. Once approved, merge the PR into main
+4. Navigate to the Releases GitHub page and create a new Draft release
+   - Set tag and title to the version number
+   - Click the Generate release notes button (update as needed)
+   - Click Save draft
+5. Publish when ready
+6. Verify the Publish Package GitHub Action completes correctly
+7. Verify a new release is available in NPM
+
+## Releasing a new version of comet-data-viz, comet-extras, etc
+
+1. Create a new release branch in the form of `comet-data-viz-release-[MAJOR.MINOR.PATCH]`
+2. Create a PR into main (should only include package.json and package-lock.json)
+3. Once approved, merge the PR into main
+4. Open a terminal on your local machine and navigate to the root of the project
+5. Run a build for the specific package (example below):
+
+```
+npm run build:comet-data-viz
+```
+
+6. Publish the new package to NPM (example below):
+
+```
+npm run publish:comet-data-viz
+```
+
+7. Verify no errors in the terminal
+8. Verify a new release is available on NPM

package.json

@@ -14,8 +14,8 @@
     "build:comet-data-viz": "cd packages/comet-data-viz && rollup -c",
     "build:comet-extras": "cd packages/comet-extras && rollup -c",
     "publish:comet-uswds": "cd packages/comet-uswds && npm publish --access public --provenance",
-    "publish:comet-data-viz": "cd packages/comet-data-viz && npm publish --access public --provenance",
-    "publish:comet-extras": "cd packages/comet-extras && npm publish --access public --provenance"
+    "publish:comet-data-viz": "cd packages/comet-data-viz && npm publish --access public",
+    "publish:comet-extras": "cd packages/comet-extras && npm publish --access public"
   },
   "devDependencies": {
     "@babel/core": "^7.19.3",