ci cd (#132)

* ci: format

* ci: run on tag push, manual dispatch

* ci: release a tip on each push to `main` and tag release on tag pushes

* ci: run on more platforms

* ci: don't fail fast

* ci: enable windows

* Update .github/workflows/rust.yml

Co-authored-by: June <61218022+itsjunetime@users.noreply.github.com>

* Update .github/workflows/rust.yml

Co-authored-by: June <61218022+itsjunetime@users.noreply.github.com>

* Update .github/workflows/rust.yml

Co-authored-by: June <61218022+itsjunetime@users.noreply.github.com>

* chore: update custom `ratatui-image` rev

* Update .github/workflows/rust.yml

Co-authored-by: June <61218022+itsjunetime@users.noreply.github.com>

* Update .github/workflows/rust.yml

Co-authored-by: June <61218022+itsjunetime@users.noreply.github.com>

* chore(deps): update kittage

* Update kittage for maybe more windows fixes

* Update kittage again for more windows fixes

* Update kittage again.....

* Maybe actually compile windows correctly now?

* update kittage

* oopsie forgot abt lock file

* windows and kittage again ...

* maybe fix the file path conversion stuff?

* kittage once again...........

---------

Co-authored-by: June <61218022+itsjunetime@users.noreply.github.com>
Co-authored-by: itsjunetime <junewelker@gmail.com>

.github/workflows/rust.yml

@@ -3,31 +3,57 @@ name: Rust
 on:
   push:
     branches: ["main"]
+    tags: ["v*.*.*"]
   pull_request:
     branches: ["main"]
+  workflow_dispatch:
+  workflow_call:
 
 env:
   CARGO_TERM_COLOR: always
+  tip_release_path: RELEASE.md
 
 jobs:
-  build:
+  test-build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - { os: "macos-latest", target: "aarch64-apple-darwin" }
+          - { os: "ubuntu-latest", target: "x86_64-unknown-linux-gnu" }
+          - {
+              os: "windows-latest",
+              target: "x86_64-pc-windows-msvc",
+              ext: ".exe",
+            }
+          - { os: "ubuntu-24.04-arm", target: "aarch64-unknown-linux-gnu" }
 
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     steps:
+      - uses: actions/checkout@v6
+
       - name: Setup sccache
         if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
         uses: mozilla-actions/sccache-action@v0.0.8
       - name: Configure sccache
         if: github.event_name != 'release' && github.event_name != 'workflow_dispatch'
         run: |
-        echo "SCCACHE_GHA_ENABLED=true" >> $GITHUB_ENV
+          echo "SCCACHE_GHA_ENABLED=true" >> "$GITHUB_ENV"
-        echo "RUSTC_WRAPPER=sccache" >> $GITHUB_ENV
+          echo "RUSTC_WRAPPER=sccache" >> "$GITHUB_ENV"
-    - name: Install build dependencies
+
-      run: |
+      - name: Setup rust cache action
-        sudo apt-get update
+        uses: swatinem/rust-cache@v2
-        sudo apt-get install -y libfontconfig1-dev libgoogle-perftools-dev google-perftools
+        with:
-    - uses: actions/checkout@v4
+          cache-on-failure: true
+
+      - name: install build dependencies on ubuntu and cache
+        if: contains(matrix.os, 'ubuntu')
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libfontconfig1-dev libgoogle-perftools-dev google-perftools
+          version: latest # could be anything
+
       - name: Install clippy and fmt
         run: rustup component add clippy rustfmt
       - name: Clippy
@@ -38,5 +64,82 @@ jobs:
         run: cargo fmt -- --check
       - name: Run benchmarks as tests
         run: cargo test --locked --benches -- adobe_example
-    - name: Build
+
-      run: cargo build --locked
+      - name: Set build mode
+        shell: bash
+        run: if [ "${{github.ref_type}}" == "tag" ] || [ ${{ github.event_name == 'push' && github.ref_name == 'main' }} ]; then echo "BMODE=production">>"$GITHUB_ENV"; fi
+
+      - name: Build in ${{env.BMODE || 'debug'}} mode
+        run: cargo build --verbose --locked --profile ${{env.BMODE || 'dev'}}
+
+      - name: Prepare artifact
+        shell: bash
+        run: |
+          mkdir -p dist
+          cp "target/${{env.BMODE || 'debug'}}/tdf${{ matrix.ext }}" dist/tdf-${{ matrix.target }}${{ matrix.ext }}
+          tree dist || ls -la dist
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v5
+        with:
+          name: tdf-${{ matrix.target }}
+          path: dist/tdf*
+
+  tag-release:
+    name: Release on tag push
+    runs-on: ubuntu-slim
+    if: github.ref_type == 'tag'
+    needs: test-build
+    steps:
+      - uses: actions/download-artifact@v6
+        with:
+          pattern: "**/tdf-*"
+          path: release-artifacts
+          merge-multiple: true
+
+      - name: What's up?
+        run: tree release-artifacts # beautiful!
+
+      - name: Create a GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          draft: true
+          generate_release_notes: true
+          files: release-artifacts/*
+          prerelease: ${{ contains(github.ref, 'alpha') || contains(github.ref, 'beta') || contains(github.ref, 'rc') }}
+
+  tip-release:
+    name: Release tip on push to main
+    runs-on: ubuntu-slim
+    if: github.event_name == 'push' && github.ref_name == 'main'
+    needs: test-build
+
+    steps:
+      - uses: actions/checkout@v6
+      - name: Download prebuilt artifacts
+        uses: actions/download-artifact@v7
+        with:
+          path: release-artifacts
+          merge-multiple: true
+
+      - name: Generate release notes
+        run: |
+          tree release-artifacts/
+          echo "From commit: $(git rev-parse --short HEAD)" > ${{ env.tip_release_path }}
+          echo "Generated on: $(date -u +"%Y-%m-%d %H:%M") UTC" >> ${{ env.tip_release_path }}
+          cat ${{ env.tip_release_path }}
+
+      - name: Update the tip tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag --force tip && git push --force origin tag tip
+
+      - name: Update the draft tip release
+        uses: softprops/action-gh-release@v2
+        with:
+          prerelease: true
+          files: release-artifacts/*
+          tag_name: tip
+          name: Tip Build
+          body_path: ${{ env.tip_release_path }}

Cargo.lock

@@ -177,9 +177,9 @@ dependencies = [
 
 [[package]]
 name = "avif-serialize"
-version = "0.8.6"
+version = "0.8.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "47c8fbc0f831f4519fe8b810b6a7a91410ec83031b8233f730a0480029f6a23f"
+checksum = "375082f007bd67184fb9c0374614b29f9aaa604ec301635f72338bb65386a53d"
 dependencies = [
  "arrayvec",
 ]
@@ -476,18 +476,18 @@ dependencies = [
 
 [[package]]
 name = "clap"
-version = "4.5.57"
+version = "4.5.58"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6899ea499e3fb9305a65d5ebf6e3d2248c5fab291f300ad0a704fbe142eae31a"
+checksum = "63be97961acde393029492ce0be7a1af7e323e6bae9511ebfac33751be5e6806"
 dependencies = [
  "clap_builder",
 ]
 
 [[package]]
 name = "clap_builder"
-version = "4.5.57"
+version = "4.5.58"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7b12c8b680195a62a8364d16b8447b01b6c2c8f9aaf68bee653be34d4245e238"
+checksum = "7f13174bda5dfd69d7e947827e5af4b0f2f94a4a3ee92912fba07a66150f21e2"
 dependencies = [
  "anstyle",
  "clap_lex",
@@ -495,9 +495,9 @@ dependencies = [
 
 [[package]]
 name = "clap_lex"
-version = "0.7.7"
+version = "1.0.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c3e64b0cc0439b12df2fa678eae89a1c56a529fd067a9115f7827f1fffd22b32"
+checksum = "3a822ea5bc7590f9d40f1ba12c0dc3c2760f3482c6984db1573ad11031420831"
 
 [[package]]
 name = "compact_str"
@@ -799,9 +799,9 @@ checksum = "7f2e5bc95e82bd8e9b333f4c5ff6dceab54e2e99f4d8cef2a680d417206ead34"
 
 [[package]]
 name = "deranged"
-version = "0.5.5"
+version = "0.5.6"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ececcb659e7ba858fb4f10388c250a7252eb0a27373f1a72b8748afdd248e587"
+checksum = "cc3dc5ad92c2e2d1c193bbbbdf2ea477cb81331de4f3103f267ca18368b988c4"
 dependencies = [
  "powerfmt",
 ]
@@ -1526,9 +1526,9 @@ dependencies = [
 
 [[package]]
 name = "kittage"
-version = "0.1.1"
+version = "0.3.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "be6b61789e2841119b210569d4acd950d47dae805f8d3235190d28cb40677632"
+checksum = "60c7c5cd12fa1b81b892fe06e04daa9e58ccd8993693378e8c1792aa0a4245fd"
 dependencies = [
  "base64-simd",
  "crossterm",
@@ -1584,9 +1584,9 @@ checksum = "bcc35a38544a891a5f7c865aca548a982ccb3b8650a5b06d0fd33a10283c56fc"
 
 [[package]]
 name = "libfuzzer-sys"
-version = "0.4.10"
+version = "0.4.12"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "5037190e1f70cbeef565bd267599242926f724d3b8a9f510fd7e0b540cfa4404"
+checksum = "f12a681b7dd8ce12bff52488013ba614b869148d54dd79836ab85aafdd53f08d"
 dependencies = [
  "arbitrary",
  "cc",
@@ -3535,9 +3535,9 @@ checksum = "d6bbff5f0aada427a1e5a6da5f1f98158182f26556f345ac9e04d36d0ebed650"
 
 [[package]]
 name = "winmmf"
-version = "0.5.1"
+version = "0.6.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "71505e812c82834e7a5a31481592e5c244d7f9177a28fb88817dfa8360b40021"
+checksum = "859506e40270a5938da41bb216376bae2e681ed8027392bddc068d62d74243f8"
 dependencies = [
  "fixedstr",
  "microseh",

Cargo.toml

@@ -41,7 +41,7 @@ nix = { version = "0.31.0", features = ["signal"] }
 mupdf = { git = "https://github.com/messense/mupdf-rs.git", rev = "d7441b9998c92135e329559c0aa71d9dc92cf4de", default-features = false, features = ["svg", "system-fonts", "img"] }
 rayon = { version = "1", default-features = false }
 # kittage = { path = "../kittage/", features = ["crossterm-tokio", "image-crate", "log"] }
-kittage = { version = "0.1.1", features = ["crossterm-tokio", "image-crate", "log"] }
+kittage = { version = "0.3.4", features = ["crossterm-tokio", "image-crate", "log"] }
 memmap2 = "0"
 csscolorparser = { version = "0.8.0", default-features = false }
 debounce = "0.2.2"

src/converter.rs

@@ -144,9 +144,13 @@ pub async fn run_conversion_loop(
 					.as_nanos() % 1_000_000;
 
 				let mut img = if shms_work {
-					kittage::image::Image::shm_from(dyn_img, &format!("/tdf_{pid}_{rn}_{page_num}"))
+					let shm_name = format!("/tdf_{pid}_{rn}_{page_num}");
-						.map_err(|e| {
+
-							RenderError::Converting(format!("Couldn't write to shm: {e:?}"))
+					#[cfg(unix)]
+					let shm_name = &*shm_name;
+
+					kittage::image::Image::shm_from(dyn_img, shm_name).map_err(|e| {
+						RenderError::Converting(format!("Couldn't create shm: {e:?}"))
 					})?
 				} else {
 					kittage::image::Image::from(dyn_img)

src/kitty.rs

@@ -78,7 +78,12 @@ pub async fn run_action<'es>(
 pub async fn do_shms_work(ev_stream: &mut EventStream) -> bool {
 	let img = DynamicImage::new_rgb8(1, 1);
 	let pid = std::process::id();
-	let Ok(mut k_img) = kittage::image::Image::shm_from(img, &format!("tdf_test_{pid}")) else {
+	let shm_name = format!("tdf_test_{pid}");
+
+	#[cfg(unix)]
+	let shm_name = &*shm_name;
+
+	let Ok(mut k_img) = kittage::image::Image::shm_from(img, shm_name) else {
 		return false;
 	};
 

src/renderer.rs

@@ -113,8 +113,15 @@ pub fn start_rendering(
 
 	let mut need_rerender = VecDeque::new();
 
+	#[cfg(windows)]
+	let path = path.to_string_lossy();
+
 	'reload: loop {
-		let doc = match Document::open(path) {
+		// Need to do this weird borrow thing so that we convert `Cow<'_, str>` -> `&str` on windows
+		// and keep unix a `&Path` -> `&Path` 'cause there are different requirements within mupdf
+		// about file paths per-platform
+		#[cfg_attr(unix, expect(clippy::borrow_deref_ref))]
+		let doc = match Document::open(&*path) {
 			Err(e) => {
 				// if there's an error, tell the main loop
 				sender.send(Err(RenderError::Doc(e)))?;

src/tui.rs

@@ -9,10 +9,6 @@ use crossterm::{
 	}
 };
 use kittage::display::DisplayLocation;
-use nix::{
-	sys::signal::{Signal::SIGSTOP, kill},
-	unistd::Pid
-};
 use ratatui::{
 	Frame,
 	layout::{Constraint, Flex, Layout, Position, Rect},
@@ -801,10 +797,17 @@ impl Tui {
 								.unwrap();
 								disable_raw_mode().unwrap();
 
+								#[cfg(unix)]
+								{
 									// This process will hang after the SIGSTOP call until we get
 									// foregrounded again by something else, at which point we need to
 									// re-setup everything so that it all gets drawn again.
-								kill(Pid::this(), SIGSTOP).unwrap();
+									nix::sys::signal::kill(
+										nix::unistd::Pid::this(),
+										nix::sys::signal::Signal::SIGSTOP
+									)
+									.unwrap();
+								}
 
 								enable_raw_mode().unwrap();
 								execute!(