Skip to content

Commit 7556ecb

Browse files
authored
chore: Add RELEASING.md, minor update to mod.md (#71)
1 parent 414eccd commit 7556ecb

File tree

2 files changed

+110
-21
lines changed

2 files changed

+110
-21
lines changed

doc/RELEASING.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# How to publish a new release
2+
3+
## 1. Ensure you're fully in sync with the remote repo
4+
5+
```bash
6+
git switch main
7+
git pull
8+
git status
9+
```
10+
11+
## 2. Create the release branch
12+
13+
```bash
14+
git switch -c vX.Y.Z
15+
```
16+
17+
## 3. Update all the occurrences of the version in the repo
18+
19+
```bash
20+
bump2version --config-file .bumpversion.cfg <increment>
21+
```
22+
23+
The `increment` parameter can be:
24+
25+
- `patch`
26+
- `minor`
27+
- `major`
28+
29+
Use the one appropriate to the version increment you're releasing.
30+
31+
## 4. Refresh `Cargo.lock`
32+
33+
```bash
34+
cd questdb-rs-ffi
35+
cargo clean
36+
cargo build
37+
```
38+
39+
## 5. Merge the release branch to master
40+
41+
```bash
42+
git commit -m "Bump version: <current> → <new>"
43+
```
44+
45+
Replace the `<current>` and `<new>` placeholders!
46+
47+
Create and merge a PR with the same name: "Bump version: \<current\>\<new\>"
48+
49+
## 6. Tag the new version
50+
51+
Once the PR is merged, pull main and add the version tag:
52+
53+
```bash
54+
git switch main
55+
git pull --prune
56+
git tag X.Y.Z
57+
git push --tags
58+
```
59+
60+
## 7. Create a new release on GitHub
61+
62+
[GitHub Release Page](https://github.com/questdb/c-questdb-client/releases)
63+
64+
On that page you'll see all the previous releases. Follow their manually-written
65+
style, and note that the style differs between patch, minor, and major releases.
66+
67+
## 8. Publish the Rust crate to crates.io
68+
69+
Ensure once more you're fully in sync with the remote repo:
70+
71+
```bash
72+
git switch main
73+
git pull
74+
git status
75+
```
76+
77+
Publish the crate:
78+
79+
```bash
80+
cd questdb-rs
81+
cargo publish --dry-run --token [your API token from crates.io]
82+
cargo publish --token [your API token from crates.io]
83+
```
84+
85+
## 9. Ensure the docs are online on docs.rs
86+
87+
The release is immediately visible on crates.io, but there's a delay until it
88+
becomes available on [https://docs.rs/](docs.rs). Watch that site and ensure it
89+
appears there.

questdb-rs/src/ingress/mod.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -65,27 +65,6 @@ QuestDB instances), call
6565
The two supported transport modes, HTTP and TCP, handle errors very differently.
6666
In a nutshell, HTTP is much better at error handling.
6767

68-
# Health Check
69-
70-
The QuestDB server has a "ping" endpoint you can access to see if it's alive,
71-
and confirm the version of InfluxDB Line Protocol with which you are
72-
interacting:
73-
74-
```shell
75-
curl -I http://localhost:9000/ping
76-
```
77-
78-
Example of the expected response:
79-
80-
```shell
81-
HTTP/1.1 204 OK
82-
Server: questDB/1.0
83-
Date: Fri, 2 Feb 2024 17:09:38 GMT
84-
Transfer-Encoding: chunked
85-
Content-Type: text/plain; charset=utf-8
86-
X-Influxdb-Version: v2.7.4
87-
```
88-
8968
## TCP
9069

9170
TCP doesn't report errors at all to the sender; instead, the server quietly
@@ -110,6 +89,27 @@ message.
11089
After the sender has signalled an error, it remains usable. You can handle the
11190
error as appropriate and continue using it.
11291

92+
# Health Check
93+
94+
The QuestDB server has a "ping" endpoint you can access to see if it's alive,
95+
and confirm the version of InfluxDB Line Protocol with which you are
96+
interacting:
97+
98+
```shell
99+
curl -I http://localhost:9000/ping
100+
```
101+
102+
Example of the expected response:
103+
104+
```shell
105+
HTTP/1.1 204 OK
106+
Server: questDB/1.0
107+
Date: Fri, 2 Feb 2024 17:09:38 GMT
108+
Transfer-Encoding: chunked
109+
Content-Type: text/plain; charset=utf-8
110+
X-Influxdb-Version: v2.7.4
111+
```
112+
113113
# Configuration Parameters
114114

115115
In the examples below, we'll use configuration strings. We also provide the

0 commit comments

Comments
 (0)