Skip to content

Commit 1dd5ad4

Browse files
committed
docs: update readme
1 parent 3078608 commit 1dd5ad4

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The UnixFS spec can be found at [ipfs/specs/UNIXFS.md](https://github.com/ipfs/s
2020
- [Structure](#structure)
2121
- [Development](#development)
2222
- [Publishing new versions](#publishing-new-versions)
23-
- [Publishing release candidates](#publishing-release-candidates)
23+
- [Using prerelease versions](#using-prerelease-versions)
2424
- [Contribute](#contribute)
2525
- [License](#license)
2626

@@ -48,11 +48,11 @@ See the scripts section of the root [`package.json`](./package.json) for more co
4848
1. Ensure you have a `GH_TOKEN` env var containing a GitHub [Personal Access Token](https://github.com/settings/tokens) with `public_repo` permissions
4949
2. From the root of this repo run `npm run release` and follow the on screen prompts. It will use [conventional commits](https://www.conventionalcommits.org) to work out the new package version
5050

51-
### Publishing release candidates
51+
### Using prerelease versions
5252

53-
To publish a release candidate use `npm run release:rc`. This will result in version numbers similar to `0.4.4-rc.0+8d4b747` published under the npm tag `next`.
53+
Any changed packages from each successful build of master are published to npm as canary builds under the npm tag `next`.
5454

55-
To update an rc, run `npm run release:rc` again.
55+
Canary builds only consider changes to packages in the last built commit so changes to the root config files should not result in new prereleases being published to npm.
5656

5757
## Contribute
5858

0 commit comments

Comments
 (0)