Skip to content

docs: Document Release Process #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alamb merged 1 commit into from
Jul 10, 2024
Merged

docs: Document Release Process #131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions RELEASING.md
View file
Open in desktop
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
```