Merge pull request #4 from babichjacob/release-plz-2024-09-30T19-19-10Z

chore: release v0.0.4

Cargo.lock

@@ -4,7 +4,7 @@ version = 3
 
 [[package]]
 name = "ac-qu-ai-nt"
-version = "0.0.3"
+version = "0.0.4"
 dependencies = [
  "ac-qu-ai-nt-cli-clap",
  "clap",
@@ -14,7 +14,7 @@ dependencies = [
 
 [[package]]
 name = "ac-qu-ai-nt-cli-clap"
-version = "0.0.3"
+version = "0.0.4"
 dependencies = [
  "clap",
  "tracing",

README.md

@@ -1,4 +1,31 @@
 # ac-qu-ai-nt
+
 `ac-qu-ai-nt` is a project I'm working on, using artificial intelligence to break down the user's query, acquire knowledge, and transfer insights to the user('s mind).
 
 This is a placeholder while I take small steps to build out the project.
+
+# Contributing
+
+This is a summary of the crates I expect to be in this project and how they are used:
+
+```mermaid
+flowchart TD
+core --> cli-clap
+core --> gui-eframe
+core --> tui-ratatui
+cli-clap --> multibinary
+gui-eframe --> multibinary
+tui-ratatui --> multibinary
+```
+
+## Versioning
+
+This project aims to adhere to [semantic versioning](https://semver.org/) using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary), conducted by [Release-plz](https://release-plz.ieni.dev/).
+
+To be more specific about what a breaking change _could_ entail:
+
+- a previously successful compilation now failing
+- the program (wrongly) exiting, panicking, reporting an error, etc, where it didn't previously
+- changing the expected result of an existing integration test (not sure if unit tests would count)
+
+All the crates in this project have a [minimum supported Rust version (MSRV)](https://rust-lang.github.io/rfcs/2495-min-rust-version.html) of 1.76, the release succeeding [the one that stabilized `async fn` in traits](https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html) (which the `core` crate of this project is expected to make use of). I intend to test this in CI (GitHub Actions) in the future to identify if it ever gets raised by changes but I have not set this up yet. Raising the MSRV will be considered a breaking change --- my justification is that it [seems more appropriate for an application like this](https://github.com/matklad/once_cell/issues/201#issuecomment-1257213601). This may be reconsidered if [Cargo's MSRV-aware resolver](https://rust-lang.github.io/rfcs/3537-msrv-resolver.html) is stabilized.

cli-clap/CHANGELOG.md

@@ -7,6 +7,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.4](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.3...ac-qu-ai-nt-cli-clap-v0.0.4) - 2024-09-30
+
+### Added
+
+- make `tracing` a crate feature and make it a default feature of the current crates
+
+### Other
+
+- *(cli-clap)* or at least I hope chore is the right conventional commit type to use - switch `println!` to a `tracing` invocation (to verify that the tracing infrastructure works)
+
 ## [0.0.3](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.2...ac-qu-ai-nt-cli-clap-v0.0.3) - 2024-09-30
 
 ### Other

cli-clap/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ac-qu-ai-nt-cli-clap"
 description = "A CLI (written with clap) for ac-qu-ai-nt"
-version = "0.0.3"
+version = "0.0.4"
 edition = "2021"
 rust-version = "1.76"
 
@@ -9,6 +9,10 @@ authors = { workspace = true }
 license = { workspace = true }
 repository = { workspace = true }
 
+[features]
+default = ["tracing"]
+tracing = ["dep:tracing"]
+
 [dependencies]
 clap = { workspace = true, features = ["derive", "env"] }
-tracing = { workspace = true }
+tracing = { workspace = true, optional = true }

cli-clap/src/lib.rs

@@ -1,3 +1,4 @@
 pub fn main() {
-    println!("Hello, world!");
+    #[cfg(feature = "tracing")]
+    tracing::info!("Hello, world!");
 }

multibinary/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.4](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.3...ac-qu-ai-nt-v0.0.4) - 2024-09-30
+
+### Added
+
+- *(multibinary)* initialize a basic tracing subscriber until this is changed to a directory one using `tracing-appender` at a later time
+- make `tracing` a crate feature and make it a default feature of the current crates
+
 ## [0.0.3](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.2...ac-qu-ai-nt-v0.0.3) - 2024-09-30
 
 ### Added

multibinary/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "ac-qu-ai-nt"
 description = "A WIP project using AI to break down a user's query, acquire the knowledge to answer it, then transfer those insights to the user"
-version = "0.0.3"
+version = "0.0.4"
 edition = "2021"
 rust-version = "1.76"
 
@@ -10,11 +10,12 @@ license = { workspace = true }
 repository = { workspace = true }
 
 [features]
-default = ["cli-clap"]
+default = ["cli-clap", "tracing"]
 cli-clap = ["dep:ac-qu-ai-nt-cli-clap"]
+tracing = ["dep:tracing-subscriber", "ac-qu-ai-nt-cli-clap?/tracing"]
 
 [dependencies]
-ac-qu-ai-nt-cli-clap = { version = "0.0.3", path = "../cli-clap", optional = true }
+ac-qu-ai-nt-cli-clap = { version = "0.0.4", path = "../cli-clap", optional = true }
 clap = { workspace = true, features = ["derive", "env"] }
 dirs-next = "2.0.0"
-tracing-subscriber = "0.3.18"
+tracing-subscriber = { version = "0.3.18", optional = true }

multibinary/src/main.rs

@@ -17,6 +17,9 @@ fn main() {
         application_data_directory,
     } = Args::parse();
 
+    #[cfg(feature = "tracing")]
+    tracing_subscriber::fmt::init();
+
     match create_dir_all(&application_data_directory) {
         Ok(()) => {}
         Err(e) if e.kind() == ErrorKind::AlreadyExists => {}