Skip to content

Commit f8291b0

Browse files
authored
Add publish instructions (#395)
1 parent 1a9f5b0 commit f8291b0

File tree

2 files changed

+43
-14
lines changed

2 files changed

+43
-14
lines changed

CONTRIBUTING.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## Publishing
2+
3+
This package uses a custom publish flow.
4+
5+
**IMPORTANT**: Do not push directly to `main` - every change must go through a PR
6+
otherwise changelog generation will fail.
7+
8+
```sh
9+
npm install
10+
npm version patch # or minor or major
11+
git push --follow-tags
12+
npm run build
13+
cd npmDist
14+
npm publish --tag=next
15+
```
16+
17+
Then test it by installing `graphql-relay@next` from npm...
18+
19+
All good? Publish:
20+
21+
```sh
22+
npm dist-tags add graphql-relay@VERSION_NUMBER latest
23+
```
24+
25+
Finally generate the CHANGELOG:
26+
27+
```sh
28+
node resources/gen-changelog.js
29+
```

package-lock.json

+14-14
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)