-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Document Release Process (#131)
- Loading branch information
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# Releasing | ||
|
||
This document describes the release process for [`pbjson`], [`pbjson-types`] and | ||
[`pbjson-build`] to crates.io. | ||
|
||
Note that `pbjson-test` is not released as it is only used for testing. | ||
|
||
[`pbjson`]: https://crates.io/crates/pbjson | ||
[`pbjson-types`]: https://crates.io/crates/pbjson-types | ||
[`pbjson-build`]: https://crates.io/crates/pbjson-build | ||
|
||
## Step 1: Update Version | ||
|
||
First make a PR to update the version (example [#127](https://github.com/influxdata/pbjson/issues/127)) | ||
|
||
## Step 2: Release | ||
Run the following commands to release `pbjson`, `pbjson-types` and `pbjson-build` | ||
|
||
```shell | ||
cargo publish -p pbjson | ||
cargo publish -p pbjson-build | ||
cargo publish -p pbjson-types | ||
``` |