From d0e7e75da055153ef19c4340e59b63a88eeea8e4 Mon Sep 17 00:00:00 2001 From: Andrew Lamb Date: Wed, 10 Jul 2024 12:56:28 -0400 Subject: [PATCH] docs: Document Release Process (#131) --- RELEASING.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000..651a48b --- /dev/null +++ b/RELEASING.md @@ -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 +```