From 6e4da966f4c5aa4541b63981462d36c75e23e992 Mon Sep 17 00:00:00 2001 From: Tejas Badadare Date: Fri, 13 Jun 2025 11:59:00 -0700 Subject: [PATCH] doc: add release changelog note to readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 9420c72177..b0e198847a 100644 --- a/README.md +++ b/README.md @@ -66,6 +66,7 @@ The general process for creating a new release is: 2. Submit a PR with the changes and merge them in to main. 3. Create a new release on github. Configure the release to create a new tag when published. Set the tag name and version for the component you wish to release -- see the [Releases](https://github.com/pyth-network/pyth-crosschain/releases) page to identify the relevant tag. 4. Publish the release. This step will automatically trigger a Github Action to build the package and release it. This step will e.g., publish packages to NPM, or build and push docker images. + - Note that when publishing a public package, you should prune the auto-generated Github release notes to only include changes relevant to the release. Otherwise, the changelog will include commits from unrelated projects in the monorepo since the previous release. Note that all javascript packages are released together using a tag of the form `pyth-js-v`. (The `number` is arbitrary.) If you have a javascript package that shouldn't be published, simply add `"private": "true"` to the `package.json` file