chore: add package descriptions so that they can actually be published

chore: release

.github/workflows/check-and-build-and-test.yml

@@ -3,6 +3,14 @@ name: Check, build, and test
 on:
   push:
     branches: ["main"]
+    # This workflow is definitely expensive for GitHub,
+    # so let's not let files that won't affect the project's ability to build and test trigger it
+    paths-ignore:
+      - ".github/**"
+      - "**/.gitignore"
+      - "**/CHANGELOG.md"
+      - "**/README.md"
+      - "**/LICENSE-*"
   pull_request:
     branches: ["main"]
 
@@ -10,28 +18,153 @@ env:
   CARGO_TERM_COLOR: always
 
 jobs:
-  check-build-and-test:
+  formatting:
     runs-on: ubuntu-latest
-    timeout-minutes: 15
+    timeout-minutes: 2
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Install Rust toolchain
+      - name: Install stable Rust toolchain
         uses: dtolnay/rust-toolchain@stable
+
+      - name: Formatting
+        run: cargo fmt --check --verbose
+
+  check-and-build:
+    strategy:
+      matrix:
+        minimal_or_latest:
+          - build_command: cargo minimal-versions build --direct --verbose
+            check_command: cargo minimal-versions check --direct --verbose
+            job_name_suffix: with minimal versions of direct dependencies
+
+          - build_command: cargo build --verbose
+            check_command: cargo check --verbose
+            job_name_suffix: (with latest (typically) versions of dependencies)
+
+        supporteds:
+          - runner: macos-latest
+            target: aarch64-apple-darwin
+
+          - runner: macos-latest
+            target: x86_64-apple-darwin
+
+          - install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
+            runner: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+
+          - install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
+            runner: ubuntu-latest
+            target: aarch64-unknown-linux-musl
+
+          - runner: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+
+          - runner: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+
+          # I would like to support this but I don't know how to install the dependencies to be able to
+          # - runner: windows-latest
+          #   target: aarch64-pc-windows-gnullvm
+
+          - runner: windows-latest
+            target: aarch64-pc-windows-msvc
+
+          - runner: windows-latest
+            target: x86_64-pc-windows-gnu
+
+          - runner: windows-latest
+            target: x86_64-pc-windows-msvc
+    name: Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }}) ${{ matrix.minimal_or_latest.job_name_suffix }}
+    runs-on: ${{ matrix.supporteds.runner }}
+    timeout-minutes: 5
+    env:
+      # https://github.com/rust-lang/stacker/issues/80#issuecomment-1547991131
+      CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
+      CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER: aarch64-linux-gnu-gcc # TODO: shouldn't this be something to do with musl, not gcc?
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install prerequisite build chain
+        if: matrix.supporteds.install_prerequisite
+        run: ${{ matrix.supporteds.install_prerequisite }}
+
+      - name: Install stable Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.supporteds.target }}
+
+      - name: Install cargo-hack
+        uses: taiki-e/install-action@cargo-hack
+      - name: Install cargo-minimal-versions
+        uses: taiki-e/install-action@cargo-minimal-versions
+
+      - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: ${{ matrix.supporteds.target }}
+          cache-on-failure: "true"
+
+      - name: Check
+        run: ${{ matrix.minimal_or_latest.check_command }} --target ${{ matrix.supporteds.target }}
+
+      - name: Build
+        run: ${{ matrix.minimal_or_latest.build_command }} --target ${{ matrix.supporteds.target }}
+
+  test:
+    strategy:
+      matrix:
+        supporteds:
+          - runner: macos-latest
+            target: aarch64-apple-darwin
+
+          - runner: macos-latest
+            target: x86_64-apple-darwin
+
+          # Not able to be tested in GitHub Actions (without emulation, at least)
+          # - runner: ubuntu-latest
+          #   target: aarch64-unknown-linux-gnu
+
+          # Not able to be tested in GitHub Actions (without emulation, at least)
+          # - runner: ubuntu-latest
+          #   target: aarch64-unknown-linux-musl
+
+          - runner: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+
+          - runner: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+
+          # Not able to be tested in GitHub Actions (without emulation, at least)
+          # - runner: windows-latest
+          #   target: aarch64-pc-windows-gnullvm
+
+          # Not able to be tested in GitHub Actions (without emulation, at least)
+          # - runner: windows-latest
+          #   target: aarch64-pc-windows-msvc
+
+          - runner: windows-latest
+            target: x86_64-pc-windows-gnu
+
+          - runner: windows-latest
+            target: x86_64-pc-windows-msvc
+    name: Test ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }})
+    runs-on: ${{ matrix.supporteds.runner }}
+    timeout-minutes: 5
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install stable Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.supporteds.target }}
+
       - name: Install Nextest
         uses: taiki-e/install-action@cargo-nextest
 
       - uses: Swatinem/rust-cache@v2
 
-      - name: Check
-        run: cargo check --verbose
-
-      - name: Formatting
-        run: cargo fmt --check --verbose
-
-      - name: Build
-        run: cargo build --verbose
-
       - name: Test
-        run: cargo nextest run
+        run: cargo nextest run --target ${{ matrix.supporteds.target }}

.github/workflows/compile-and-publish-binaries-to-release.yml

@@ -9,8 +9,48 @@ on:
 
 jobs:
   compile-and-publish:
-    runs-on: ubuntu-latest
-    timeout-minutes: 15
+    strategy:
+      matrix:
+        supporteds:
+          - runner: macos-latest
+            target: aarch64-apple-darwin
+
+          - runner: macos-latest
+            target: x86_64-apple-darwin
+
+          - install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
+            runner: ubuntu-latest
+            target: aarch64-unknown-linux-gnu
+
+          - install_prerequisite: sudo apt-get update && sudo apt-get install gcc-aarch64-linux-gnu
+            runner: ubuntu-latest
+            target: aarch64-unknown-linux-musl
+
+          - runner: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+
+          - runner: ubuntu-latest
+            target: x86_64-unknown-linux-musl
+
+          # I would like to support this but I don't know how to install the dependencies to be able to
+          # - runner: windows-latest
+          #   target: aarch64-pc-windows-gnullvm
+
+          - runner: windows-latest
+            target: aarch64-pc-windows-msvc
+
+          - runner: windows-latest
+            target: x86_64-pc-windows-gnu
+
+          - runner: windows-latest
+            target: x86_64-pc-windows-msvc
+    name: Compile ${{ matrix.supporteds.target }} for release (on ${{ matrix.supporteds.runner }})
+    runs-on: ${{ matrix.supporteds.runner }}
+    timeout-minutes: 10
+    env:
+      # https://github.com/rust-lang/stacker/issues/80#issuecomment-1547991131
+      CARGO_TARGET_AARCH64_UNKNOWN_LINUX_GNU_LINKER: aarch64-linux-gnu-gcc
+      CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER: aarch64-linux-gnu-gcc # TODO: shouldn't this be something to do with musl, not gcc?
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -19,11 +59,24 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
 
       - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: ${{ matrix.supporteds.target }}
+          cache-on-failure: "true"
 
       - name: Build for release
         run: cargo build --release --verbose
 
-      - uses: taiki-e/upload-rust-binary-action@v1
+      # Have to do it like this because of https://github.com/actions/runner/issues/1985
+      - if: startsWith(github.event.release.tag_name, 'ac-qu-ai-nt-v')
+        uses: taiki-e/upload-rust-binary-action@v1
         with:
           bin: ac-qu-ai-nt
           token: ${{ secrets.GITHUB_TOKEN }}
+          target: ${{ matrix.supporteds.target }}
+
+      - if: startsWith(github.event.release.tag_name, 'ac-qu-ai-nt-cli-clap-v')
+        uses: taiki-e/upload-rust-binary-action@v1
+        with:
+          bin: ac-qu-ai-nt-cli-clap
+          token: ${{ secrets.GITHUB_TOKEN }}
+          target: ${{ matrix.supporteds.target }}

Cargo.lock

@@ -4,9 +4,11 @@ version = 3
 
 [[package]]
 name = "ac-qu-ai-nt"
-version = "0.0.4"
+version = "0.0.8"
 dependencies = [
  "ac-qu-ai-nt-cli-clap",
+ "ac-qu-ai-nt-gui-eframe",
+ "ac-qu-ai-nt-tui-ratatui",
  "clap",
  "dirs-next",
  "tracing-subscriber",
@@ -14,12 +16,33 @@ dependencies = [
 
 [[package]]
 name = "ac-qu-ai-nt-cli-clap"
-version = "0.0.4"
+version = "0.0.5"
 dependencies = [
  "clap",
  "tracing",
 ]
 
+[[package]]
+name = "ac-qu-ai-nt-core"
+version = "0.0.1"
+dependencies = [
+ "tracing",
+]
+
+[[package]]
+name = "ac-qu-ai-nt-gui-eframe"
+version = "0.0.1"
+dependencies = [
+ "tracing",
+]
+
+[[package]]
+name = "ac-qu-ai-nt-tui-ratatui"
+version = "0.0.1"
+dependencies = [
+ "tracing",
+]
+
 [[package]]
 name = "anstream"
 version = "0.6.15"

Cargo.toml

@@ -1,5 +1,5 @@
 [workspace]
-members = ["cli-clap", "multibinary"]
+members = ["core", "cli-clap", "gui-eframe", "tui-ratatui", "multibinary"]
 resolver = "2"
 
 [workspace.package]

cli-clap/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.5](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-cli-clap-v0.0.4...ac-qu-ai-nt-cli-clap-v0.0.5) - 2024-10-05
+
+### Other
+
+- change `Hello, world!` to `What's up world?` to allow me to cut a release
+
 ## [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

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.4"
+version = "0.0.5"
 edition = "2021"
 rust-version = "1.76"
 

cli-clap/src/lib.rs

@@ -1,4 +1,4 @@
 pub fn main() {
     #[cfg(feature = "tracing")]
-    tracing::info!("Hello, world!");
+    tracing::info!("What's up, world?");
 }

core/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1](https://github.com/babichjacob/ac-qu-ai-nt/releases/tag/ac-qu-ai-nt-core-v0.0.1) - 2024-10-06
+
+### Added
+
+- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`
+
+### Other
+
+- run cargo fmt

core/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "ac-qu-ai-nt-core"
+description = "The core library of ac-qu-ai-nt. If you're looking for the application, see cli-clap or gui-eframe or tui-ratatui or the multibinary"
+version = "0.0.1"
+edition = "2021"
+rust-version = "1.76"
+
+authors = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+
+[features]
+default = ["tracing"]
+tracing = ["dep:tracing"]
+
+[dependencies]
+tracing = { workspace = true, optional = true }

core/src/lib.rs

@@ -0,0 +1 @@
+

gui-eframe/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1](https://github.com/babichjacob/ac-qu-ai-nt/releases/tag/ac-qu-ai-nt-gui-eframe-v0.0.1) - 2024-10-06
+
+### Added
+
+- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`

gui-eframe/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "ac-qu-ai-nt-gui-eframe"
+description = "A GUI (written with egui / eframe) for ac-qu-ai-nt"
+version = "0.0.1"
+edition = "2021"
+rust-version = "1.76"
+
+authors = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+
+[features]
+default = ["tracing"]
+tracing = ["dep:tracing"]
+
+[dependencies]
+tracing = { workspace = true, optional = true }

gui-eframe/src/lib.rs

@@ -0,0 +1,4 @@
+pub fn main() {
+    #[cfg(feature = "tracing")]
+    tracing::info!("Hello from the eframe-based GUI!");
+}

gui-eframe/src/main.rs

@@ -0,0 +1 @@
+use ac_qu_ai_nt_gui_eframe::main;

multibinary/CHANGELOG.md

@@ -7,6 +7,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.8](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.7...ac-qu-ai-nt-v0.0.8) - 2024-10-06
+
+### Added
+
+- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`
+
+## [0.0.7](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.6...ac-qu-ai-nt-v0.0.7) - 2024-10-05
+
+### Other
+
+- updated the following local packages: ac-qu-ai-nt-cli-clap
+
+## [0.0.6](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.5...ac-qu-ai-nt-v0.0.6) - 2024-10-05
+
+### Fixed
+
+- cover the new cases of `Command` for `GuiEframe` and `TuiRatatui`
+
+### Other
+
+- correctly add `gui-eframe` and `tui-ratatui` as features this time around
+- add `gui-eframe` and `tui-ratatui` as subcommands with aliases `gui` and `tui` respectively
+- add `gui-eframe` and `tui-ratatui` as features
+
+## [0.0.5](https://github.com/babichjacob/ac-qu-ai-nt/compare/ac-qu-ai-nt-v0.0.4...ac-qu-ai-nt-v0.0.5) - 2024-10-05
+
+### Other
+
+- [**breaking**] put accessing the cli under a subcommand like the README suggests it would be
+
 ## [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/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.4"
+version = "0.0.8"
 edition = "2021"
 rust-version = "1.76"
 
@@ -10,12 +10,25 @@ license = { workspace = true }
 repository = { workspace = true }
 
 [features]
-default = ["cli-clap", "tracing"]
+default = ["cli-clap", "gui-eframe", "tui-ratatui", "tracing"]
+
 cli-clap = ["dep:ac-qu-ai-nt-cli-clap"]
-tracing = ["dep:tracing-subscriber", "ac-qu-ai-nt-cli-clap?/tracing"]
+gui-eframe = ["dep:ac-qu-ai-nt-gui-eframe"]
+tui-ratatui = ["dep:ac-qu-ai-nt-tui-ratatui"]
+
+tracing = [
+    "dep:tracing-subscriber",
+    "ac-qu-ai-nt-cli-clap?/tracing",
+    "ac-qu-ai-nt-gui-eframe?/tracing",
+    "ac-qu-ai-nt-tui-ratatui?/tracing",
+]
 
 [dependencies]
-ac-qu-ai-nt-cli-clap = { version = "0.0.4", path = "../cli-clap", optional = true }
+ac-qu-ai-nt-cli-clap = { version = "0.0.5", path = "../cli-clap", optional = true }
+ac-qu-ai-nt-gui-eframe = { version = "0.0.1", path = "../gui-eframe", optional = true }
+ac-qu-ai-nt-tui-ratatui = { version = "0.0.1", path = "../tui-ratatui", optional = true }
+
 clap = { workspace = true, features = ["derive", "env"] }
 dirs-next = "2.0.0"
+
 tracing-subscriber = { version = "0.3.18", optional = true }

multibinary/src/main.rs

@@ -1,6 +1,6 @@
 use std::{fs::create_dir_all, io::ErrorKind, path::PathBuf};
 
-use clap::Parser;
+use clap::{Parser, Subcommand};
 
 #[derive(Debug, Parser)]
 struct Args {
@@ -10,11 +10,28 @@ struct Args {
         default_value_os_t = dirs_next::data_local_dir().expect("sorry but you're on a platform where dirs_next::data_local_dir() returned None, so please specify a data directory for the application").join("ac-qu-ai-nt")
     )]
     application_data_directory: PathBuf,
+
+    #[command(subcommand)]
+    command: Command,
+}
+
+#[derive(Debug, Subcommand)]
+enum Command {
+    #[cfg(feature = "cli-clap")]
+    #[command(alias = "cli")]
+    CliClap,
+    #[cfg(feature = "gui-eframe")]
+    #[command(alias = "gui")]
+    GuiEframe,
+    #[cfg(feature = "tui-ratatui")]
+    #[command(alias = "tui")]
+    TuiRatatui,
 }
 
 fn main() {
     let Args {
         application_data_directory,
+        command,
     } = Args::parse();
 
     #[cfg(feature = "tracing")]
@@ -38,6 +55,12 @@ fn main() {
         }
     }
 
-    #[cfg(feature = "cli-clap")]
-    ac_qu_ai_nt_cli_clap::main();
+    match command {
+        #[cfg(feature = "cli-clap")]
+        Command::CliClap => ac_qu_ai_nt_cli_clap::main(),
+        #[cfg(feature = "gui-eframe")]
+        Command::GuiEframe => ac_qu_ai_nt_gui_eframe::main(),
+        #[cfg(feature = "tui-ratatui")]
+        Command::TuiRatatui => ac_qu_ai_nt_tui_ratatui::main(),
+    }
 }

tui-ratatui/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.0.1](https://github.com/babichjacob/ac-qu-ai-nt/releases/tag/ac-qu-ai-nt-tui-ratatui-v0.0.1) - 2024-10-06
+
+### Added
+
+- initialize `core`, `gui-eframe`, and `tui-ratatui` crates and use them in the `multibinary`

tui-ratatui/Cargo.toml

@@ -0,0 +1,17 @@
+[package]
+name = "ac-qu-ai-nt-tui-ratatui"
+description = "A TUI (written with Ratatui) for ac-qu-ai-nt"
+version = "0.0.1"
+edition = "2021"
+rust-version = "1.76"
+
+authors = { workspace = true }
+license = { workspace = true }
+repository = { workspace = true }
+
+[features]
+default = ["tracing"]
+tracing = ["dep:tracing"]
+
+[dependencies]
+tracing = { workspace = true, optional = true }

tui-ratatui/src/lib.rs

@@ -0,0 +1,4 @@
+pub fn main() {
+    #[cfg(feature = "tracing")]
+    tracing::info!("This is from the TUI based on Ratatui.");
+}

tui-ratatui/src/main.rs

@@ -0,0 +1 @@
+use ac_qu_ai_nt_tui_ratatui::main;