From 49a7478e06d2ecfaf72a79a9fdc20dabc068a8c5 Mon Sep 17 00:00:00 2001 From: Ryan Goree Date: Mon, 12 Feb 2024 02:14:42 -0600 Subject: [PATCH] Add release details to README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index fde867e8..3c6ca0bf 100644 --- a/README.md +++ b/README.md @@ -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!**