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.

Sign up for GitHub

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

Update release procedure #395

Merged
merged 1 commit into from
Dec 15, 2023
Merged

Update release procedure #395

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 19 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1413,20 +1413,34 @@ yarn link ../mappersmith/lib

### Release

First, update package version and generate an updated `CHANGELOG.md`:
1. Create a release branch, e.g. `git checkout -b release/2.43.0`
2. Update package version and generate an updated `CHANGELOG.md`:

```sh
yarn changeset version
```

Second, build the `lib/` folder which will be published to npm:
3. Merge the PR.
4. From `master`: pull the latest changes, and build the `dist/` folder which will be published to npm:

```sh
yarn build:project
yarn publish:prepare
```

Finally, publish to npm:
5. Verify the release works. If you are using `npm pack` to create a local tarball, delete this file after the verification has been done.
6. Finally, publish the contents of `dist/` folder to npm:

```sh
cd dist/
rm *.tgz # do not accidentally publish any tarball
npm publish
```

7. Tag the release and push the tags.

```sh
yarn changeset publish
git tag 2.43.0
git push --tags
```

## Linting
Expand Down