chore: release

chore(ac-qu-ai-nt): release v0.0.6

.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,164 @@ 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 stable Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Formatting
+        run: cargo fmt --check --verbose
+
+  check-and-build:
+    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: Check and build ${{ matrix.supporteds.target }} (on ${{ matrix.supporteds.runner }})
+    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 }}
+
+      - uses: Swatinem/rust-cache@v2
+        with:
+          shared-key: ${{ matrix.supporteds.target }}
+          cache-on-failure: "true"
+
+      - name: Check
+        run: cargo check --verbose --target ${{ matrix.supporteds.target }}
+
+      - name: Build
+        run: cargo build --verbose --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: Test
+        run: cargo nextest run --target ${{ matrix.supporteds.target }}
+
+  minimal-dependencies-check-build-and-test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
-      - name: Install Nextest
-        uses: taiki-e/install-action@cargo-nextest
+      - name: Install cargo-minimal-versions
+        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
 
-      - name: Check
-        run: cargo check --verbose
+      - name: Check (minimal direct dependencies)
+        run: cargo minimal-versions check --direct --workspace
 
-      - name: Formatting
-        run: cargo fmt --check --verbose
+      - name: Build (minimal direct dependencies)
+        run: cargo minimal-versions build --direct --workspace
 
-      - name: Build
-        run: cargo build --verbose
-
-      - name: Test
-        run: cargo nextest run
+      - name: Test (minimal direct dependencies)
+        run: cargo minimal-versions test --direct --workspace

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

@@ -9,8 +9,52 @@ on:
 
 jobs:
   compile-and-publish:
-    runs-on: ubuntu-latest
-    timeout-minutes: 15
+    if: ${{ startsWith(github.event.release.tag_name, format('{0}-v', matrix.crate)) }}
+    strategy:
+      matrix:
+        crate:
+          - ac-qu-ai-nt
+          - ac-qu-ai-nt-cli-clap
+        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 +63,15 @@ 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
         with:
-          bin: ac-qu-ai-nt
+          bin: ${{ matrix.crate }}
           token: ${{ secrets.GITHUB_TOKEN }}
+          target: ${{ matrix.supporteds.target }}

Cargo.lock

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

README.md

@@ -1,9 +1,50 @@
-# 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.
 
+# Installation
+
+## Automatically Updatable
+You won't find it very useful yet, because it doesn't really do much of anything, but you can install the multibinary with [Binstall](https://github.com/cargo-bins/cargo-binstall). This means you don't need to have the same development environment (which will require the Vulkan SDK and CUDA Toolkit in the future) in order to use the program, because you'll just download a precompiled executable.
+
+```sh
+cargo-binstall -y ac-qu-ai-nt
+```
+
+Install [`cargo-update`](https://github.com/nabijaczleweli/cargo-update) and periodically run
+```sh
+cargo install-update --all
+```
+in order to keep this program up to date.
+
+I'm not sure if you need a Rust compiler installed for either or if they can work standalone.
+
+## Just the Executable
+Head to [the Releases page](https://github.com/babichjacob/ac-qu-ai-nt/releases) and download the asset corresponding to your computer architecture and operating system.
+
+Decompress the archive and place the executable contained within it somewhere useful to you (e.g. in a directory in [your `PATH` variable](https://superuser.com/a/284351)).
+
+# Usage
+If it's your preference, you should be able to double click the executable in the folder to be able to run it (defaulting to launching a graphical interface (once I actually make one lol)).
+
+You could also type
+```sh
+ac-qu-ai-nt
+```
+on the command line to run it. This is also a way to launch a GUI (once there actually is one) for the application.
+
+## Command Line Interface
+It's going to be a goal of this project for there to be feature parity between the GUI, CLI, and TUI.
+
+If you want to use its command line interface, start with
+
+```sh
+ac-qu-ai-nt cli
+```
+to see what capabilities are available.
+
+(This is an alias for `ac-qu-ai-nt cli-clap` to allow the possibility of experimenting with different implementations of the same type of interface.)
+
 # Contributing
 
 This is a summary of the crates I expect to be in this project and how they are used:
@@ -28,4 +69,13 @@ To be more specific about what a breaking change _could_ entail:
 - 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.
+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](https://github.com/babichjacob/ac-qu-ai-nt/issues/5) 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.
+
+## License
+
+All contents of this repository are licensed under either the
+* [MIT license](LICENSE-MIT), or
+* [Apache 2.0 license](LICENSE-APACHE), or
+* [Unlicense](LICENSE-UNLICENSE)
+
+at your option.

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?");
 }

multibinary/CHANGELOG.md

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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.7"
 edition = "2021"
 rust-version = "1.76"
 
@@ -10,12 +10,16 @@ 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"]
+gui-eframe = []
+tui-ratatui = []
+
 tracing = ["dep:tracing-subscriber", "ac-qu-ai-nt-cli-clap?/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 }
 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 => todo!(),
+        #[cfg(feature = "tui-ratatui")]
+        Command::TuiRatatui => todo!(),
+    }
 }