From 3c4084ba1d510af97e60d44d673f5817b8dcb134 Mon Sep 17 00:00:00 2001 From: Steve Dignam Date: Wed, 2 Apr 2025 22:43:15 -0400 Subject: [PATCH] docs: update release info in readme --- README.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index da570443..35d43f79 100644 --- a/README.md +++ b/README.md @@ -242,22 +242,20 @@ s/new-rule 'prefer big serial' ### releasing a new version -1. update the CHANGELOG.md and bump version in the cli `Cargo.toml`, ensure the - lock file is updated, and update `package.json` and commit the changes +1. Update the `CHANGELOG.md` + + Include a description of any fixes / additions. Make sure to include the PR numbers and credit the authors. + +2. Run `s/update-version` ```bash - # update version in Cargo.toml files and package.json to 4.5.3 + # update version in cli/Cargo.toml, package.json, flake.nix to 4.5.3 s/update-version 4.5.3 ``` -2. create a new release on github - CI will attach the binaries automatically -3. wait for build artifacts to be attached to release. -4. login to `npm` and publish new version. +3. Create a new release on GitHub - ```bash - npm login - npm publish - ``` + Use the text and version from the `CHANGELOG.md` ### algolia