1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
name: release
# Builds release binaries on every `v*` tag, packages them per platform,
# and publishes them to a GitHub Release. Users then install via:
# * `cargo binstall inkhaven` (uses [package.metadata.binstall] in
# Cargo.toml to fetch the matching prebuilt)
# * Direct download from the Releases page
# * `cargo install --git https://github.com/vulogov/blackInkhaven`
# (compiles from source against vendored deps)
#
# Manual run is also possible via the Actions tab → "Run workflow".
on:
push:
tags:
- 'v*'
workflow_dispatch:
inputs:
tag:
description: "Tag to release (e.g. v1.0.1)"
required: true
type: string
permissions:
contents: write # needed to create the Release and upload assets
env:
CARGO_TERM_COLOR: always
RUST_BACKTRACE: 1
jobs:
# ----------------------------------------------------------------------
# Build a release binary on each target platform. Each matrix job
# produces one tarball / zip uploaded as a workflow artifact; the
# `release` job below collects them and posts the GitHub Release.
# ----------------------------------------------------------------------
build:
name: build (${{ matrix.target }})
runs-on: ${{ matrix.os }}
# 1.2.4+: Windows is soft-failure. The vcpkg fontconfig install
# below is what makes the Rust link step succeed, but it can
# break in subtle ways (runner image updates, vcpkg version
# drift). When it does, we still want the Linux + Mac assets
# to publish — Windows users can fall back to `cargo install
# --git` until we patch the workflow.
continue-on-error: ${{ matrix.target == 'x86_64-pc-windows-msvc' }}
strategy:
fail-fast: false
matrix:
include:
- os: ubuntu-latest
target: x86_64-unknown-linux-gnu
archive: tar.gz
- os: macos-latest
target: aarch64-apple-darwin
archive: tar.gz
- os: windows-latest
target: x86_64-pc-windows-msvc
archive: zip
# macOS x86_64 (Intel) stays disabled. The macos-13
# runner pool is heavily capacity-constrained — v1.0.2's job
# sat in `queued` for 3+ hours without picking up a runner.
# Apple stopped selling Intel Macs in 2023; modern users are
# on Apple Silicon (aarch64) above. Intel-Mac users can still
# `cargo install --git`. Re-enable once GitHub-hosted macos-13
# runner availability improves OR by adopting a self-hosted
# Intel-Mac runner.
# - os: macos-13
# target: x86_64-apple-darwin
# archive: tar.gz
#
# Windows note (1.2.4+): re-enabled, gated by
# `continue-on-error`. The `yeslogic-fontconfig-sys`
# transitive dep — pulled in via
# `bundcore → rust_dynamic → neurons → plotters → font-kit`
# (NOT bdslib, which was absorbed in 1.2.1) — needs a
# native fontconfig install on Windows. We do that with
# `vcpkg install fontconfig:x64-windows-static-md` in
# the "Install Windows build dependencies" step below;
# pkg-config picks it up via PKG_CONFIG_PATH. If the
# vcpkg install regresses, the matrix entry still runs
# but its failure won't block the release.
steps:
- name: Resolve tag
id: tag
shell: bash
run: |
if [ -n "${{ inputs.tag }}" ]; then
echo "value=${{ inputs.tag }}" >> "$GITHUB_OUTPUT"
else
echo "value=${GITHUB_REF#refs/tags/}" >> "$GITHUB_OUTPUT"
fi
- uses: actions/checkout@v4
with:
ref: ${{ steps.tag.outputs.value }}
- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
targets: ${{ matrix.target }}
# Linux: install system libs that the transitive native deps
# need. fontconfig comes in via yeslogic-fontconfig-sys; the xcb-*
# set covers arboard's X11 clipboard backend; libssl-dev is a common
# baseline. macOS and Windows runners use platform-native equivalents.
- name: Install Linux build dependencies
if: runner.os == 'Linux'
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends \
pkg-config \
libfontconfig1-dev \
libssl-dev \
libxcb1-dev \
libxcb-render0-dev \
libxcb-shape0-dev \
libxcb-xfixes0-dev \
libasound2-dev
# Windows: vcpkg the same fontconfig native lib that
# `yeslogic-fontconfig-sys` shells out to find on Linux. The
# `x64-windows-static-md` triplet is the standard for Rust
# MSVC builds (static native lib, dynamic CRT). The
# GitHub-hosted windows-latest runner ships vcpkg pre-
# installed at `$env:VCPKG_INSTALLATION_ROOT`; we just need
# to drive it. PKG_CONFIG_PATH points the build script at
# the resulting `.pc` files.
#
# Other native Windows deps:
# - audio (rodio/cpal) uses WASAPI from the Windows SDK,
# already on the runner — no install needed.
# - clipboard (arboard) uses the Windows clipboard API,
# same story.
# - duckdb's bundled SQLite/ICU build on Windows out of
# the box with MSVC.
- name: Install Windows build dependencies
if: runner.os == 'Windows'
shell: pwsh
run: |
& "$env:VCPKG_INSTALLATION_ROOT\vcpkg.exe" install fontconfig:x64-windows-static-md
$pkgcfg = "$env:VCPKG_INSTALLATION_ROOT\installed\x64-windows-static-md\lib\pkgconfig"
echo "PKG_CONFIG_PATH=$pkgcfg" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
echo "VCPKGRS_TRIPLET=x64-windows-static-md" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
# Caches `~/.cargo` + `target/` between runs. Critical: bdslib
# pulls in duckdb / tantivy / fastembed / augurs, so a cold build
# is 10–15 minutes. The cache key includes Cargo.lock so a real
# dep change still rebuilds.
- name: Cache cargo
uses: Swatinem/rust-cache@v2
with:
key: ${{ matrix.target }}
# Linux glibc target — Ubuntu's default toolchain is fine.
# Windows / macOS pick the platform compilers automatically.
- name: Build (release)
run: cargo build --release --locked --target ${{ matrix.target }}
# Strip & package. The on-disk layout inside the archive is
# `inkhaven-<target>/inkhaven[.exe]` so the cargo-binstall
# `bin-dir` in Cargo.toml ("{name}-{target}/{bin}{binary-ext}")
# resolves cleanly.
- name: Package (unix)
if: matrix.os != 'windows-latest'
shell: bash
run: |
set -euo pipefail
DIR="inkhaven-${{ matrix.target }}"
mkdir -p "$DIR"
cp "target/${{ matrix.target }}/release/inkhaven" "$DIR/"
cp README.md LICENSE "$DIR/" 2>/dev/null || true
strip "$DIR/inkhaven" || true
tar -czf "$DIR.tar.gz" "$DIR"
ls -la "$DIR.tar.gz"
- name: Package (windows)
if: matrix.os == 'windows-latest'
shell: pwsh
run: |
$dir = "inkhaven-${{ matrix.target }}"
New-Item -ItemType Directory -Force -Path $dir | Out-Null
Copy-Item "target/${{ matrix.target }}/release/inkhaven.exe" "$dir/"
if (Test-Path README.md) { Copy-Item README.md "$dir/" }
if (Test-Path LICENSE) { Copy-Item LICENSE "$dir/" }
Compress-Archive -Path $dir -DestinationPath "$dir.zip"
- name: Upload artifact
uses: actions/upload-artifact@v4
with:
name: inkhaven-${{ matrix.target }}
path: |
inkhaven-${{ matrix.target }}.tar.gz
inkhaven-${{ matrix.target }}.zip
if-no-files-found: ignore
retention-days: 7
# ----------------------------------------------------------------------
# Collect every artifact and publish a single GitHub Release.
# ----------------------------------------------------------------------
release:
name: publish release
needs: build
runs-on: ubuntu-latest
steps:
- name: Resolve tag
id: tag
shell: bash
run: |
if [ -n "${{ inputs.tag }}" ]; then
echo "value=${{ inputs.tag }}" >> "$GITHUB_OUTPUT"
else
echo "value=${GITHUB_REF#refs/tags/}" >> "$GITHUB_OUTPUT"
fi
- uses: actions/checkout@v4
with:
ref: ${{ steps.tag.outputs.value }}
- name: Download all artifacts
uses: actions/download-artifact@v4
with:
path: dist
merge-multiple: true
- name: List artifacts
run: ls -la dist
- name: Create / update GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ steps.tag.outputs.value }}
name: ${{ steps.tag.outputs.value }}
draft: false
prerelease: ${{ contains(steps.tag.outputs.value, '-') }}
generate_release_notes: true
files: |
dist/inkhaven-*.tar.gz
dist/inkhaven-*.zip
body: |
Inkhaven ${{ steps.tag.outputs.value }} — TUI literary editor.
## Install
* `cargo binstall inkhaven` (downloads the prebuilt matching your host triple)
* `cargo install --git https://github.com/vulogov/blackInkhaven --tag ${{ steps.tag.outputs.value }}` (compiles from source)
* Or pick the right archive below and unpack it into `$PATH`.
## Docs
* Quick start: [README](https://github.com/vulogov/blackInkhaven/blob/${{ steps.tag.outputs.value }}/README.md)
* Full manual: [Documentation/](https://github.com/vulogov/blackInkhaven/tree/${{ steps.tag.outputs.value }}/Documentation)