Skip to content

Commit cc46b6b

Browse files
bluestreak01bluestreak01
authored
Bump version to 0.1.1
2 parents bc21678 + 605f21e commit cc46b6b

File tree

8 files changed

+87
-28
lines changed

8 files changed

+87
-28
lines changed

‎DEV_NOTES.md

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Dev notes
2+
3+
## Build and test
4+
5+
```
6+
cargo clean
7+
cargo build
8+
cargo test
9+
cd questdb-confstr-ffi/cpp_test
10+
./compile
11+
./run
12+
```
13+
14+
## Linting
15+
16+
In addition, before pushing a PR, please run:
17+
```
18+
cargo fmt --all
19+
cargo clippy --all-targets -- -D warnings
20+
```
21+
22+
## Cutting a release
23+
24+
Let us assume we want to cut version `0.1.1` and the current version is `0.1.0`.
25+
26+
### 1. New branch
27+
```shell
28+
git switch -c v0.1.1
29+
```
30+
31+
### 2. Update the version in both `Cargo.toml` files
32+
33+
```shell
34+
$EDITOR questdb-confstr/Cargo.toml
35+
$EDITOR questdb-confstr-ffi/Cargo.toml
36+
```
37+
38+
### 3. Re-run all tests and lints
39+
40+
Don't forget about _clippy_: The newest version of Rust might have picked up
41+
some new lints that we need to fix.
42+
43+
### 4. Commit the changes and create a PR
44+
```shell
45+
git add -u
46+
git commit -m "Bump version to 0.1.1"
47+
git push --set-upstream origin v0.1.1
48+
```
49+
50+
N.B: _We don't need to update any `Cargo.lock` files for the ffi crate since
51+
there are no dependencies._
52+
53+
### 5. Create a new PR, get it reviewed and merge it
54+
55+
https://github.com/questdb/questdb-confstr-rs/pull/new/
56+
57+
### 6. Publish both crates to crates.io
58+
59+
```shell
60+
cargo login
61+
62+
(cd questdb-confstr && cargo publish --dry-run)
63+
(cd questdb-confstr-ffi && cargo publish --dry-run)
64+
65+
(cd questdb-confstr && cargo publish)
66+
(cd questdb-confstr && cargo publish)
67+
```
68+
69+
(If in doubt, see the
70+
"[Publishing on crates.io](https://doc.rust-lang.org/cargo/reference/publishing.html)" guide)
71+
72+
### 7. Write the release notes
73+
74+
* [Create a new release](https://github.com/questdb/questdb-confstr-rs/releases) on GitHub.
75+
* Specify what changed in the release notes.
76+
* Keep it readable (not autogenerated) and short.

‎README.md

+3-20
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,7 @@
11
# QuestDB configuration string parser
22

3-
This is for:
4-
* The [questdb-confstr](./questdb-confstr) crate
3+
Consists of:
4+
* The [questdb-confstr](./questdb-confstr) crate (documents grammar)
55
* and its bindings for C [questdb-confstr-ffi](./questdb-confstr-ffi)
66

7-
## Dev notes
8-
9-
To build and test:
10-
11-
```
12-
cargo clean
13-
cargo build
14-
cargo test
15-
cd questdb-confstr-ffi/cpp_test
16-
./compile
17-
./run
18-
```
19-
20-
In addition, before pushing a PR, please run:
21-
```
22-
cargo fmt --all
23-
cargo clippy --all-targets -- -D warnings
24-
```
7+
See the [developer notes](./DEV_NOTES.md) for more details on building, testing and cutting a release.

‎questdb-confstr-ffi/Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "questdb-confstr-ffi"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
edition = "2021"
55
license = "Apache-2.0"
66
description = "C FFI bindings for questdb-confstr"
@@ -13,4 +13,4 @@ authors = ["Adam Cimarosti <adam@questdb.io>"]
1313
questdb-confstr = { path = "../questdb-confstr", version = "0.1.0" }
1414

1515
[lib]
16-
crate-type = ["lib", "staticlib"]
16+
crate-type = ["lib", "staticlib"]

‎questdb-confstr-ffi/cpp_test/test.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* \__\_\\__,_|\___||___/\__|____/|____/
77
*
88
* Copyright (c) 2014-2019 Appsicle
9-
* Copyright (c) 2019-2024 QuestDB
9+
* Copyright (c) 2019-2025 QuestDB
1010
*
1111
* Licensed under the Apache License, Version 2.0 (the "License");
1212
* you may not use this file except in compliance with the License.

‎questdb-confstr-ffi/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* \__\_\\__,_|\___||___/\__|____/|____/
77
*
88
* Copyright (c) 2014-2019 Appsicle
9-
* Copyright (c) 2019-2024 QuestDB
9+
* Copyright (c) 2019-2025 QuestDB
1010
*
1111
* Licensed under the Apache License, Version 2.0 (the "License");
1212
* you may not use this file except in compliance with the License.

‎questdb-confstr/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "questdb-confstr"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
edition = "2021"
55
license = "Apache-2.0"
66
description = "A parser for a configuration string format handling service names and parameters"

‎questdb-confstr/src/lib.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* \__\_\\__,_|\___||___/\__|____/|____/
77
*
88
* Copyright (c) 2014-2019 Appsicle
9-
* Copyright (c) 2019-2024 QuestDB
9+
* Copyright (c) 2019-2025 QuestDB
1010
*
1111
* Licensed under the Apache License, Version 2.0 (the "License");
1212
* you may not use this file except in compliance with the License.
@@ -101,7 +101,7 @@ impl<'a> PartialEq<&'a ErrorKind> for ErrorKind {
101101
}
102102
}
103103

104-
impl<'a> PartialEq<ErrorKind> for &'a ErrorKind {
104+
impl PartialEq<ErrorKind> for &ErrorKind {
105105
fn eq(&self, other: &ErrorKind) -> bool {
106106
*self == other
107107
}

‎questdb-confstr/tests/tests.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* \__\_\\__,_|\___||___/\__|____/|____/
77
*
88
* Copyright (c) 2014-2019 Appsicle
9-
* Copyright (c) 2019-2024 QuestDB
9+
* Copyright (c) 2019-2025 QuestDB
1010
*
1111
* Licensed under the Apache License, Version 2.0 (the "License");
1212
* you may not use this file except in compliance with the License.

0 commit comments

Comments
 (0)