Skip to content

Commit 9a343f7

Browse files
doc: add release changelog note to readme (#2783)
1 parent 78a1148 commit 9a343f7

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ The general process for creating a new release is:
6868
2. Submit a PR with the changes and merge them in to main.
6969
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.
7070
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.
71+
- 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.
7172

7273
Note that all javascript packages are released together using a tag of the form `pyth-js-v<number>`. (The `number` is arbitrary.)
7374
If you have a javascript package that shouldn't be published, simply add `"private": "true"` to the `package.json` file

0 commit comments

Comments
 (0)