Prepare for release

Author: joerivanruth

CHANGELOG.md

@@ -0,0 +1,27 @@
+# Change Log
+
+## mapiproxy NEXTVERSION - YYYY-MM-DD
+
+First public release.
+
+- This version can be used to connect to MonetDB and execute queries.
+  The API is subject to change.
+
+- There are typed getters for boolean and the various integer types.
+  Other types, including decimals and temporal types, must be retrieved
+  as strings and converted manually.
+
+- Understands the full MonetDB URL syntax, though not all features have been
+  implemented.
+
+- There is a demo program and a number of unit tests but this release has
+  not seen much testing.
+
+- Has been tested mostly with MonetDB versions Aug2024 (11.51.3) and
+  Jun2020 (11.37.13) but older versions are believed to work fine.
+
+- Works with Rust 1.80.0, the exact minimum supported Rust version yet to be
+  decided.
+
+- Extremely basic and untested TLS support can optionally be compiled in
+  be enabling the `rustls` Cargo feature.

Cargo.toml

@@ -1,9 +1,18 @@
 [package]
 name = "monetdb"
-version = "0.1.1"
-edition = "2021"
+version = "0.2.0-alpha.1"
+description = "Client library for MonetDB, a high performance SQL database for analytics"
+authors = [ "Joeri van Ruth <joeri.van.ruth@monetdbsolutions.com>" ]
+keywords = [ "monetdb", "database", "sql" ]
+categories = [ "database" ]
 license = "MPL-2.0"
 
+edition = "2021"
+
+readme = "README.md"
+homepage = "https://github.com/MonetDB/monetdb-rust"
+repository = "https://github.com/MonetDB/monetdb-rust"
+
 [lib]
 # doctest = false
 
@@ -25,12 +34,12 @@ ripemd = "0.1.3"
 rustls = { version="0.23.13", optional = true }
 rustls-platform-verifier = { version="0.3.4", optional = true }
 sha2 = "0.10.8"
-thiserror = "1.0.63"
+thiserror = "1.0.64"
 time = { version="0.3.36", features = [ "alloc", "std", "local-offset" ] }
 url = "2.5.2"
 
 [dev-dependencies]
-anyhow = "1.0.88"
+anyhow = "1.0.89"
 bstr = "1.10.0"
 itertools = "0.13.0"
 simplelog = "0.12.2"

README.md

@@ -36,7 +36,7 @@ fn main() -> Result<(), Box<dyn Error>> {
 // host=Some("totoro") clientpid=Some(1914127) client=Some("monetdb-rust 0.1.1") remark=None
 ```
 
-You can also use a [`Parameters`] object to fine tune the connection parameters:
+You can also use a `Parameters` object to fine tune the connection parameters:
 
 ```rust
 # use std::error::Error;
@@ -55,7 +55,7 @@ Current status
 * Support for MonetDB Jun2020 (11.37.7) and higher. Older versions are highly
   likely to work but haven't been tested. If you need this, just ask.
 
-* Rust 1.81 and higher. (TODO: check this)
+* Rust 1.80 and higher, older versions have not yet been tested.
 
 * The full `monetdb://` connection URL syntax is supported, though not all features have been implemented.
 

checklicense.py

@@ -21,6 +21,7 @@ def find_files_to_check():
         ('checklicense.py', ''),
         ('.gitignore', ''),
         ('Cargo.toml', ''),
+        ('release.toml', ''),
         ('LICENSE', ''),
         ('TODO.org', ''),
     ]

notes/202410-how-to-release.md

@@ -0,0 +1,66 @@
+How to release a new version of monetdb-rust
+============================================
+
+To prepare for the release, first make sure [CHANGELOG.md] contains all relevant
+changes, the documentation is tidy, CI is clean, etc. etc. Script
+`checklicense.py` can be used to check if all files contain a copyright notice.
+
+Note: there is no need to add a new section header to [CHANGELOG.md], the
+scripts will do that.
+
+Then use [cargo release] to create a new section in in [CHANGELOG.md], bump the
+version number in Cargo.toml, create a Git tag, publish the crate on [crates.io]
+and push the tag to GitHub. This can be done with a single command,  e.g.,
+`cargo release minor`, but you can also let it perform the steps separately. See
+Section [Steps](#steps) below.
+
+Note: until we are a bit more experienced, the automated 'publish' and 'push' steps have been disabled and must be performed manually.
+
+When this is done, use `cargo release alpha` to switch the main branch back to a
+development version number. For example, after releasing version 0.7.10, `cargo
+release alpha` bumps to version 0.7.11-alpha.1. Push this commit to GitHub too,
+but do not tag it.
+
+Also, you need to manually create a GitHub release from the tag,
+with text copy-pasted from [CHANGELOG.md].
+I don't think [cargo release] can automate that.
+
+
+Steps
+-----
+
+The configuration file for [cargo release] is [release.toml].
+When in doubt, check the [documentation][cargo release docs].
+
+When you run for example `cargo release minor`, [cargo release] will perform all
+steps below. The command to run individual steps is noted in the stepTo execute
+individual steps, write `cargo release version <version>`, `cargo release
+replace`, etc. You can also perform these actions by hand if that feels safer.
+
+1. `cargo release version <major|minor|patch|alpha>`. Bumps the version number in
+   Cargo.toml.
+
+2. `cargo release replace`. Adds a section for this version to [CHANGELOG.md], containing
+   the items that used to be in section "NEXTVERSION".
+
+3. `cargo release hook`. Runs the pre-release hooks configured in [release.toml].
+   At the time of writing, this checks the copyright messages.
+
+4. `cargo release commit`. Commits the changed version number and the updated
+   CHANGELOG.md. The commit message is configured in [release.toml].
+
+5. `cargo release publish`. Currently disabled in [release.toml], runs `cargo
+   publish`. Before running this, set env var `CARGO_REGISTRY_TOKEN`
+   to a token obtained from `cargo login` or https://crates.io/me.
+
+6. `cargo release tag`. Creates a tag `vMAJOR.MINOR.PATCH`.
+
+7. `cargo release push`. Pushes the commits to GitHub. Currently disabled in
+   [release.toml].
+
+
+[cargo release]: https://github.com/crate-ci/cargo-release
+[cargo release docs]: https://github.com/crate-ci/cargo-release/blob/master/docs/reference.md
+[CHANGELOG.md]: ../CHANGELOG.md
+[crates.io]: https://crates.io
+[release.toml]: ../release.toml

notes/README.md

@@ -4,10 +4,20 @@ Design notes
 Having a coherent and up to date design document is a bit too much at this point
 but it's a good idea to keep some notes.
 
-1. [getting-started](./202409-001-getting-started.md)
+Favorites
+---------
 
-2. [name-notes](./202409-naming.md)
+*. [how to release](./202410-how-to-release.md)
 
-3. [license](./202410-license.md)
+In chronological order
+----------------------
 
-4. [status](./202410-status.md)
+*. [getting-started](./202409-001-getting-started.md)
+
+*. [name-notes](./202409-naming.md)
+
+*. [license](./202410-license.md)
+
+*. [status](./202410-status.md)
+
+*. [how to release](./202410-how-to-release.md)

release.toml

@@ -0,0 +1,19 @@
+# Config for the 'cargo release' command.
+# This can be installed with `cargo install cargo-release`.
+# Documentation: https://github.com/crate-ci/cargo-release/blob/master/docs/reference.md
+
+# for the time being we push and publish manually
+push = false
+publish = false
+
+pre-release-hook = [ "./checklicense.py", "--check" ]
+pre-release-commit-message = "Release {{crate_name}} version {{version}}"
+tag = true
+tag-message = "Release {{crate_name}} {{version}}"
+
+[[pre-release-replacements]]
+file = "CHANGELOG.md"
+search = "## mapiproxy NEXTVERSION - .*"
+exactly = 1
+replace = "## mapiproxy NEXTVERSION - YYYY-MM-DD\n\n\n## mapiproxy {{version}} - {{date}}"
+

src/toplevel.md

@@ -52,7 +52,7 @@ Current status
 * Support for MonetDB Jun2020 (11.37.7) and higher. Older versions are highly
   likely to work but haven't been tested. If you need this, just ask.
 
-* Rust 1.81 and higher. (TODO: check this)
+* Rust 1.80 and higher, older versions have not yet been tested.
 
 * The full `monetdb://` connection URL syntax is supported, though not all features have been implemented.