Skip to content

Commit ab830eb

Browse files
Merge pull request #352 from FormidableLabs/provenance-fixes
setting up NPM Provenance
2 parents d335122 + 4511c46 commit ab830eb

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

.changeset/funny-ligers-fail.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"react-live": patch
3+
---
4+
5+
Setup NPM Provenance

CONTRIBUTING.MD

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,43 @@ Thanks for taking the time to help us make react-live even better! Before you go
3434
- Run lint and flow using `yarn run lint`
3535
- Update the [type definitions](./typings/react-live.d.ts) for anything that modifies the React-Live API, like breaking changes or new features.
3636

37+
### Changesets
38+
39+
We use [changesets](https://github.com/changesets/changesets) to create package versions and publish them.
40+
41+
If your work contributes changes that require a change in version to any of the packages, add a changeset by running:
42+
43+
```sh
44+
$ yarn changeset
45+
```
46+
47+
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.
48+
49+
After this, you'll see a new uncommitted file in `.changesets` that looks something like:
50+
51+
```
52+
$ git status
53+
# ....
54+
Untracked files:
55+
(use "git add <file>..." to include in what will be committed)
56+
.changeset/flimsy-pandas-marry.md
57+
```
58+
59+
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.
60+
3761
## Releasing a new version to NPM (only for project administrators)
3862

63+
<details>
64+
<summary>
65+
<i>Only for project administrators</i>
66+
</summary>
67+
3968
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.
4069
2. Run `npm publish` and publish to npm if all is well.
4170
3. Run `git push && git push --tags`
4271

72+
</details>
73+
4374
## Contributor Covenant Code of Conduct
4475

4576
### Our Pledge

0 commit comments

Comments
 (0)