From 012b2083bc5c974f1c4f99d72721c9caa59463e2 Mon Sep 17 00:00:00 2001 From: Paul Marsicovetere Date: Mon, 1 May 2023 11:42:57 -0400 Subject: [PATCH 1/2] setting up NPM Provenance --- .changeset/funny-ligers-fail.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/funny-ligers-fail.md diff --git a/.changeset/funny-ligers-fail.md b/.changeset/funny-ligers-fail.md new file mode 100644 index 0000000..0a13308 --- /dev/null +++ b/.changeset/funny-ligers-fail.md @@ -0,0 +1,5 @@ +--- +"react-live": patch +--- + +Setup NPM Provenance From 4511c4676c428286106d237e6499f2322d8b47ed Mon Sep 17 00:00:00 2001 From: Paul Marsicovetere Date: Mon, 1 May 2023 11:46:32 -0400 Subject: [PATCH 2/2] setting up NPM Provenance --- CONTRIBUTING.MD | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD index 4cfed5e..b9dac7f 100644 --- a/CONTRIBUTING.MD +++ b/CONTRIBUTING.MD @@ -34,12 +34,43 @@ Thanks for taking the time to help us make react-live even better! Before you go - Run lint and flow using `yarn run lint` - Update the [type definitions](./typings/react-live.d.ts) for anything that modifies the React-Live API, like breaking changes or new features. +### Changesets + +We use [changesets](https://github.com/changesets/changesets) to create package versions and publish them. + +If your work contributes changes that require a change in version to any of the packages, add a changeset by running: + +```sh +$ yarn changeset +``` + +which will open an interactive CLI menu. Use this menu to select which packages need versioning, which semantic version changes are needed, and add appropriate messages accordingly. + +After this, you'll see a new uncommitted file in `.changesets` that looks something like: + +``` +$ git status +# .... +Untracked files: + (use "git add ..." to include in what will be committed) + .changeset/flimsy-pandas-marry.md +``` + +Review this file, make any necessary adjustments, and commit the file to source. During the next package release, the changes (and changeset notes) will be automatically incorporated based on these changeset files. + ## Releasing a new version to NPM (only for project administrators) +
+ +Only for project administrators + + 1. Run `npm version patch` (or `minor`, `major` as appropriate) to run tests and lint, build the `lib` and `dist` directories, and automatically update the `package.json` with a new git tag. 2. Run `npm publish` and publish to npm if all is well. 3. Run `git push && git push --tags` +
+ ## Contributor Covenant Code of Conduct ### Our Pledge