Skip to content

Commit 1b149fb

Browse files
committed
docs: document release process
Signed-off-by: Kevin Viglucci <[email protected]>
1 parent a41e50a commit 1b149fb

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

+32
Original file line numberDiff line numberDiff line change
@@ -151,3 +151,35 @@ Pass `--help` to see configuration options.
151151
## License
152152
By contributing to rsocket-js, you agree that your contributions will be
153153
licensed under the LICENSE file in the root directory of this source tree.
154+
155+
## Releasing
156+
157+
### Step 1: Build
158+
159+
To release a new version you first need to build the various packages.
160+
161+
```bash
162+
yarn run build
163+
```
164+
165+
Before continuing you should validate the build output is as expected.
166+
167+
### Step 2: Bump versions
168+
169+
You can bump versions using the `lerna version` command, and selecting an appropriate next version.
170+
171+
Note: `lerna version` will create and push new git tags.
172+
173+
## Step 3: Publishing
174+
175+
You can publish the locally built packages to npm using the following command.
176+
177+
From the Lerna docs:
178+
179+
> Lerna will compare the version of every package in the repository with the version of it that is published to npm. For
180+
> each package that has a version that is greater than the published version, Lerna will publish that package to npm.
181+
182+
```bash
183+
lerna publish from-package
184+
```
185+

0 commit comments

Comments
 (0)