@hashicorp/mktg-global-styles - npm Package Compare versions

Comparing version 4.3.1 to 4.4.0-canary-20221116152808

package.json

 {
   "name": "@hashicorp/mktg-global-styles",
   "description": "global styles shared across HashiCorp sites",
-  "version": "4.3.1",
+  "version": "4.4.0-canary-20221116152808",
   "author": "HashiCorp",
@@ -11,3 +11,4 @@ "contributors": [
   "devDependencies": {
-    "release": "^6.3.0"
+    "@changesets/changelog-github": "^0.4.7",
+    "@changesets/cli": "^2.25.2"
   },
@@ -20,7 +21,6 @@ "license": "MPL-2.0",
   "scripts": {
-    "release:major": "release major && npm publish",
-    "release:minor": "release minor && npm publish",
-    "release:patch": "release patch && npm publish"
+    "release": "changeset publish",
+    "release:canary": "changeset publish --tag canary"
   },
   "style": "style.css"
 }

README.md

@@ -32,25 +32,39 @@
 
-## Publishing changes
+## Publishing
 
-> **Note**
-> For now, this is a manual process.
+Publishing is handled through the [`changesets` library](https://github.com/atlassian/changesets). Publishing is done in CI if changes are found. For more information on how to work with changesets, see [this document](https://github.com/atlassian/changesets/blob/main/docs/adding-a-changeset.md).
 
-Make sure to increment the package version after any code changes are merged.
+### Adding a changeset
 
-- ```bash
-  npm version patch|minor|major
-  ```
-- Commit/PR/Merge this change
+Run the following command and follow the prompt:
 
-Authenticate with NPM.
+```
+npx changeset
+```
 
-- ```bash
-  npm login
-  # Go through the options
-  # You can use "NPM hashibot-web" in the shared 1password vault
-  ```
-- ```bash
-  npm publish
-  ```
+To make any adjustments to your changeset, just edit the file!
 
+### Releases
+
+The release process is handled mostly automatically via the changesets GitHub action. When changeset files get merged to `main`, a Pull Request is opened which will, upon merge, release all pending changesets and remove the changeset files. We should not need to publish manually with this flow. See the `changesets/action`(https://github.com/changesets/action) repo for more information.
+
+### Canary Releases
+
+If you want to test your changes before merging, you can add a `release:canary` label to your pull request. If any changeset files are found, a release will be created and tagged with `canary`. You can then install the canary version elsewhere:
+
+```
+npm install @hashicorp/mktg-global-styles@canary
+```
+
+### Prereleases
+
+Prereleases are also handled through a process integrated into `changesets`. The full flow is outlined in [this document](https://github.com/atlassian/changesets/blob/main/docs/prereleases.md). To enter a prerelease mode for the `canary` tag, we would do something like this:
+
+```
+npx changeset pre enter canary
+GITHUB_TOKEN=<your token> npx changeset version
+GITHUB_TOKEN=<your token> npx changeset publish
+```
+
+To continue publishing preleases, use the `npx changeset` command like normal and use the `version` and `publish` commands as appropriate.
   

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1037021

increased by0.37%

Number of package files

38

increased by15.15%

Lines of code

1053

increased by1.84%

Number of lines in readme file

70

increased by25%

Worsened metrics

Dev dependency count

2

increased by100%

Number of low quality alerts

2

increased by100%

No dependency changes