Skip to content

Commit 5d6241c

Browse files
authored
Document releasing process (#71)
1 parent 9b453fb commit 5d6241c

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

RELEASING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# How to release this crate
2+
3+
This project consists of two crates which need to be published to crates.io in the correct order. Additonally, there's some steps one's likely to miss when releasing.
4+
5+
## Pre-Release-Checklist
6+
7+
- [ ] `influxdb/Cargo.toml` and `influxdb-derive/Cargo.toml`: Bumped `influxdb` and `influxdb-derive` versions to new version number?
8+
- [ ] `influxdb/Cargo.toml`: Changed `influxdb` dependecy on `influxdb-derive` to new version number?
9+
- [ ] `CHANGELOG.md`: Remove all entries from the unreleased section
10+
- [ ] `CHANGELOG.md`: Add new Section for the new version number with subsections `Added`, `Changed` and `Fixed`.
11+
- [ ] `CHANGELOG.md`: For each commit since the last release commit `Release vX.Y.Z`, added a changelog entry in the correct section linking to the author and PR in this format?
12+
```
13+
([@GithubUserName](https://github.com/GithubUserName) in [#PRNumber](https://github.com/Empty2k12/influxdb-rust/pull/PRNumber))
14+
```
15+
- [ ] `CHANGELOG.md`: At the bottom, changed the unreleased section link to `NEWVERSIONNUMBER...HEAD` and created a new link for the current release?
16+
- [ ] `influxdb/lib.rs`: Changed the version number mentioned in the doc-comment to the new version number?
17+
- [ ] `influxdb/lib.rs`: If the release contains any new features that should be mentioned in the Github Readme, are they listed in the doc-comment?
18+
- [ ] `terminal`: Updated README with `cargo readme -r influxdb -t ../README.tpl > README.md`?
19+
- [ ] `terminal`: Verified there are no errors with clippy `cargo clippy --all-targets --all-features -- -D warnings`?
20+
21+
## Releasing
22+
23+
1) `git add .` and `git commit -m "Release vX.Y.Z"`
24+
2) `git tag vX.Y.Z`
25+
3) `git push origin master` and `git push --tags`
26+
4) `(cd influxdb-derive/ && cargo publish)`
27+
5) `(cd influxdb/ && cargo publish)`
28+
6) Create a Release in the Github Web UI

0 commit comments

Comments
 (0)