Skip to content

Commit 910adac

Browse files
authored
docs: update release info in readme (#421)
1 parent 9baac35 commit 910adac

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -242,22 +242,20 @@ s/new-rule 'prefer big serial'
242242

243243
### releasing a new version
244244

245-
1. update the CHANGELOG.md and bump version in the cli `Cargo.toml`, ensure the
246-
lock file is updated, and update `package.json` and commit the changes
245+
1. Update the `CHANGELOG.md`
246+
247+
Include a description of any fixes / additions. Make sure to include the PR numbers and credit the authors.
248+
249+
2. Run `s/update-version`
247250

248251
```bash
249-
# update version in Cargo.toml files and package.json to 4.5.3
252+
# update version in cli/Cargo.toml, package.json, flake.nix to 4.5.3
250253
s/update-version 4.5.3
251254
```
252255

253-
2. create a new release on github - CI will attach the binaries automatically
254-
3. wait for build artifacts to be attached to release.
255-
4. login to `npm` and publish new version.
256+
3. Create a new release on GitHub
256257

257-
```bash
258-
npm login
259-
npm publish
260-
```
258+
Use the text and version from the `CHANGELOG.md`
261259

262260
### algolia
263261

0 commit comments

Comments
 (0)