0.1.1 (#15)

* Add notes about version management

* Add a script for conditionally running yarn version check

* Bump version to 0.1.1

.github/workflows/check.yml

@@ -29,4 +29,6 @@ jobs:
         run: yarn check:types
 
       - name: Version
-        run: yarn version check
+        run:
+          git fetch origin main --depth 1 && ./scripts/if-no-version-change.sh
+          yarn version check

.husky/pre-push

@@ -1,4 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname -- "$0")/_/husky.sh"
 
-yarn version check
+./scripts/if-no-version-change.sh yarn version check

CONTRIBUTING.md

@@ -31,3 +31,16 @@ And you can build output files with `yarn build`.
 You can run tests with `yarn test`. If you want to run tests in "watch" mode,
 use `yarn test -w`. See the [Jest CLI docs](https://jestjs.io/docs/cli) for more
 information.
+
+## Version management
+
+We use yarn's "deferred versioning" release flow, documented
+[here](https://yarnpkg.com/features/release-workflow#deferred-versioning). For
+any change that affects source code files, developers will be asked at
+`git push` time to use `yarn version check -i` to specify what kind of change
+(`patch`, `minor`, or `major`) is contained within the release. This version
+type will be documented in the form of a new YAML file added to the
+`.yarn/versions` directory, which can be reviewed during code review.
+
+Maintainers can then later use `yarn version apply --all` to aggregate the
+proposed version bumps and apply them to the `package.json` file.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nytimes/react-prosemirror",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "license": "Apache-2.0",
   "type": "module",
   "main": "dist/cjs/index.js",

scripts/if-no-version-change.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+if git diff origin/main -- package.json | grep -e '^+ *"version":'
+then
+  echo "Not checking version; version was changed in this branch"
+else
+  "$@"
+fi