Skip to content

Commit 968a4af

Browse files
committed
chore: Setting up bump2version for consistent version numbers across all libs.
1 parent 7c7b1c8 commit 968a4af

File tree

7 files changed

+57
-8
lines changed

7 files changed

+57
-8
lines changed

.bumpversion.cfg

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
[bumpversion]
2+
current_version = 2.0.0
3+
commit = True
4+
tag = False
5+
6+
[bumpversion:file:CMakeLists.txt]
7+
search = project(c-questdb-client VERSION {current_version})
8+
replace = project(c-questdb-client VERSION {new_version})
9+
10+
[bumpversion:file:doc/SECURITY.md]
11+
search = questdb-rs/{current_version}/
12+
replace = questdb-rs/{new_version}/
13+
14+
[bumpversion:file:questdb-rs/Cargo.toml]
15+
search = version = "{current_version}"
16+
replace = version = "{new_version}"
17+
18+
[bumpversion:file:questdb-rs/README.md]
19+
search = questdb-rs = "{current_version}"
20+
replace = questdb-rs = "{new_version}"
21+
22+
[bumpversion:file:./questdb-rs/README.md]
23+
search = questdb-rs/{current_version}/
24+
replace = questdb-rs/{new_version}/
25+
26+
[bumpversion:file:questdb-rs-ffi/Cargo.toml]
27+
search = version = "{current_version}"
28+
replace = version = "{new_version}"

doc/DEV_NOTES.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,24 @@ feature.
5353
This generated files should be not be checked in:
5454
* `include/questdb/ilp/line_sender.gen.h`
5555
* `cython/questdb/ilp/line_sender.pxd`
56+
57+
## Updating version in the codebase before releasing
58+
59+
* Ensure you have `python3` and `bump2version` installed (`python3 -m pip install bump2version`).
60+
61+
```console
62+
bump2version --config-file .bumpversion.cfg patch
63+
```
64+
65+
Last argument argument:
66+
* `patch` would bump from (for example) `0.1.0` to `0.1.1`.
67+
* `minor` would bump from `0.1.0` to `0.2.0`.
68+
* `major` would bump from `0.1.0` to `1.0.0`.
69+
70+
* For more command line options, see: https://pypi.org/project/bump2version/
71+
72+
If you're editing the config file, a good set of arguments to debug issues is:
73+
74+
```
75+
bump2version --dry-run --allow-dirty --verbose --config-file .bumpversion.cfg patch
76+
```

doc/SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The `tls_certs` directory of this project contains tests certificates, its
2525
[README](tls_certs/README.md) page describes generating your own certs.
2626

2727
For API usage:
28-
* Rust: `SenderBuilder`'s [`auth`](https://docs.rs/questdb-rs/0.0.1/questdb/ingress/struct.SenderBuilder.html#method.auth)
29-
and [`tls`](https://docs.rs/questdb-rs/0.0.1/questdb/ingress/struct.SenderBuilder.html#method.tls) methods.
28+
* Rust: `SenderBuilder`'s [`auth`](https://docs.rs/questdb-rs/2.0.0/questdb/ingress/struct.SenderBuilder.html#method.auth)
29+
and [`tls`](https://docs.rs/questdb-rs/2.0.0/questdb/ingress/struct.SenderBuilder.html#method.tls) methods.
3030
* C: [examples/line_sender_c_example_auth.c](examples/line_sender_c_example_auth.c)
3131
* C++: [examples/line_sender_cpp_example_auth.cpp](examples/line_sender_cpp_example_auth.cpp)

questdb-rs-ffi/Cargo.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

questdb-rs-ffi/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "questdb-rs-ffi"
3-
version = "0.0.1"
3+
version = "2.0.0"
44
edition = "2021"
55
publish = false
66

questdb-rs/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "questdb-rs"
3-
version = "0.0.1"
3+
version = "2.0.0"
44
edition = "2021"
55
license = "Apache-2.0"
66
description = "QuestDB Client Library for Rust"

questdb-rs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ To start using `questdb-rs` add it to your `Cargo.toml`:
66

77
```toml
88
[dependencies]
9-
questdb-rs = "0.0.1"
9+
questdb-rs = "2.0.0"
1010
```
1111

1212
## Docs
1313

14-
See documentation for the [`ingress`](https://docs.rs/questdb-rs/0.0.1/questdb/ingress/) module to insert data into QuestDB via the ILP protocol.
14+
See documentation for the [`ingress`](https://docs.rs/questdb-rs/2.0.0/questdb/ingress/) module to insert data into QuestDB via the ILP protocol.
1515

1616
* Latest API docs: [https://docs.rs/questdb-rs/latest/](https://docs.rs/questdb-rs/latest/)
1717

0 commit comments

Comments
 (0)