Merge pull request #125 from FormidableLabs/ci-provenance

GitHub Actions release workflow addition

Author: paulmarsicloud

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+	"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+	"changelog": [
+		"@svitejs/changesets-changelog-github-compact",
+		{
+			"repo": "FormidableLabs/react-fast-compare"
+		}
+	],
+	"access": "public",
+	"baseBranch": "master"
+}

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      id-token: write
+      issues: write
+      repository-projects: write
+      deployments: write
+      packages: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Unit Tests
+        run: yarn test
+
+      - name: PR or Publish
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          version: yarn changeset version
+          publish: yarn changeset publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

CONTRIBUTING.md

@@ -9,20 +9,20 @@ Before contributing, _please make sure the issue relates directly to this librar
 
 We encourage pull requests concerning:
 
-* React features not handled in this library
-* Integrating updates from `fast-deep-equal` － This, unfortunately, now requires more manual work. Use the comment blocks in `index.js`
+- React features not handled in this library
+- Integrating updates from `fast-deep-equal` － This, unfortunately, now requires more manual work. Use the comment blocks in `index.js`
   to figure out what to paste and where.
-* Integrating tests from `fast-deep-equal` － This usually entails upgrading the `git`-based dependencies of `fast-deep-equal-git` and
+- Integrating tests from `fast-deep-equal` － This usually entails upgrading the `git`-based dependencies of `fast-deep-equal-git` and
   `npm`-published package of `fast-deep-equal` in `package.json:devDependencies`.
-* Bugs in this library
-* New tests for React
-* Documentation
+- Bugs in this library
+- New tests for React
+- Documentation
 
 Pull requests that should be for [fast-deep-equal](https://github.com/epoberezkin/fast-deep-equal):
 
-* Equality of non-react comparisons
-* Performance of non-react comparisons
-* Tests for non-react comparisons
+- Equality of non-react comparisons
+- Performance of non-react comparisons
+- Tests for non-react comparisons
 
 ## Development
 
@@ -130,23 +130,52 @@ please flag to your reviewers and have a discussion about whether or not the siz
 
 3. Confirm you aren't impacting our bundle size.
    If you _do_ affect the bundle size, please update the bundle badge in the Readme by
-   * Following the steps outlined in [size](#size):
+   - Following the steps outlined in [size](#size):
      `yarn -s compress && yarn size-min-gz`
-   * Grabbing that output and replacing the current size in the bundle_img: (`https://img.shields.io/badge/minzipped%20size-<NEW_SIZE>%20B-flatgreen.svg`)
+   - Grabbing that output and replacing the current size in the bundle_img: (`https://img.shields.io/badge/minzipped%20size-<NEW_SIZE>%20B-flatgreen.svg`)
      For example, if the new size is `650`, the new bundle_img will be `https://img.shields.io/badge/minzipped%20size-650%20B-flatgreen.svg`
-   * _Org members:_ Update the README's benchmark comparison png using this [internal Google Sheet template](https://docs.google.com/spreadsheets/d/1GuqpO0wgPjQ9usx6sR3t0Y_HTmAdRqjXkSjs3SBsmTc/edit?usp=sharing_eip&ts=5ed1642f).
+   - _Org members:_ Update the README's benchmark comparison png using this [internal Google Sheet template](https://docs.google.com/spreadsheets/d/1GuqpO0wgPjQ9usx6sR3t0Y_HTmAdRqjXkSjs3SBsmTc/edit?usp=sharing_eip&ts=5ed1642f).
 
-## Releasing a new version to NPM
+### Using changesets
 
-_Only for project administrators_
+Our official release path is to use automation to perform the actual publishing of our packages. The steps are to:
+
+1. A human developer adds a changeset. Ideally this is as a part of a PR that will have a version impact on a package.
+2. On merge of a PR our automation system opens a "Version Packages" PR.
+3. On merging the "Version Packages" PR, the automation system publishes the packages.
+
+Here are more details:
+
+### Add a changeset
+
+When you would like to add a changeset (which creates a file indicating the type of change), in your branch/PR issue this command:
 
 ```sh
-# (1) Run tests, lint, build published dir, update package.json
-$ npm version [patch|minor|major|<version>]
+$ yarn changeset
+```
+
+to produce an interactive menu. Navigate the packages with arrow keys and hit `<space>` to select 1+ packages. Hit `<return>` when done. Select semver versions for packages and add appropriate messages. From there, you'll be prompted to enter a summary of the change. Some tips for this summary:
+
+1. Aim for a single line, 1+ sentences as appropriate.
+2. Include issue links in GH format (e.g. `#123`).
+3. You don't need to reference the current pull request or whatnot, as that will be added later automatically.
 
-# (2) If all is well, publish the new version to the npm registry
-$ npm publish
+After this, you'll see a new uncommitted file in `.changesets` like:
 
-# (3) Then, update github with the associated tag
-$ git push && git push --tags
+```sh
+$ git status
+# ....
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+	.changeset/flimsy-pandas-marry.md
 ```
+
+Review the file, make any necessary adjustments, and commit it to source. When we eventually do a package release, the changeset notes and version will be incorporated!
+
+### Creating versions
+
+On a merge of a feature PR, the changesets GitHub action will open a new PR titled `"Version Packages"`. This PR is automatically kept up to date with additional PRs with changesets. So, if you're not ready to publish yet, just keep merging feature PRs and then merge the version packages PR later.
+
+### Publishing packages
+
+On the merge of a version packages PR, the changesets GitHub action will publish the packages to npm.

package.json

@@ -20,7 +20,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/FormidableLabs/react-fast-compare.git"
+    "url": "https://github.com/FormidableLabs/react-fast-compare"
   },
   "keywords": [
     "fast",
@@ -39,6 +39,8 @@
   "devDependencies": {
     "@babel/core": "^7.21.0",
     "@babel/preset-env": "^7.20.2",
+    "@changesets/cli": "^2.26.1",
+    "@svitejs/changesets-changelog-github-compact": "^0.1.1",
     "@testing-library/dom": "^9.0.1",
     "@testing-library/preact": "^3.2.3",
     "@types/node": "^18.15.0",