Skip to content

Commit

Permalink
docs: Document Release Process (#131)
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb authored Jul 10, 2024
1 parent 929346f commit d0e7e75
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions RELEASING.md
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
```

0 comments on commit d0e7e75

Please sign in to comment.