Skip to content

Commit

Permalink
Add release details to README
Browse files Browse the repository at this point in the history
  • Loading branch information
ryangoree committed Feb 12, 2024
1 parent 3c52903 commit 49a7478
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,21 @@ library agnostic.
[Viem](https://viem.sh/).
- **[@delvtech/evm-client-ethers](./packages/evm-client-ethers):** Bindings for
[Ethers](https://ethers.org/).

## Creating a release

This repo uses [changesets](https://github.com/changesets/changesets) to manage
versioning and changelogs. This means you shouldn't need to manually change of
the internal package versions.

Before opening a PR, run `yarn changeset` and follow the prompts to describe the
changes you've made. This will create a changeset file that should be committed.

As changesets are committed to the `main` branch, the [changesets github
action](https://github.com/changesets/action) in the release workflow will
automatically keep track of the pending `package.json` and `CHANGELOG.md`
updates in an open PR titled `chore: version packages`.

Once this PR is merged, the release workflow will be triggered, creating new
tags and github releases, and publishing the updated packages to NPM. **These
PRs should be carefully reviewed!**

0 comments on commit 49a7478

Please sign in to comment.