Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add publish instructions #395

Merged
merged 4 commits into from
Jul 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Publishing

This package uses a custom publish flow.

**IMPORTANT**: Do not push directly to `main` - every change must go through a PR
otherwise changelog generation will fail.

```sh
npm install
npm version patch # or minor or major
git push --follow-tags
npm run build
cd npmDist
npm publish --tag=next
```

Then test it by installing `graphql-relay@next` from npm...

All good? Publish:

```sh
npm dist-tags add graphql-relay@VERSION_NUMBER latest
```

Finally generate the CHANGELOG:

```sh
node resources/gen-changelog.js
```
28 changes: 14 additions & 14 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading