bookclerk_dev::package

Development These docs follow the development version and change with every merge.

Last updated View as Markdown

Release packaging aligned with docs/plugins/registry.md artifact naming.

Item Kind Summary
host_target_triple function Host rustc target triple for the machine running the packager.
bookclerk_target function Canonical Bookclerk artifact target for the host (e.g. linux-x64-gnu).
normalize_bookclerk_target function Map a Bookclerk target or legacy rustc triple to a Bookclerk target name.
uses_zip_archive function Whether archives for this Bookclerk target (or rustc triple) use .zip.
package_plugins function Packages discovered plugin guests into the release artifacts directory.
package_hosts function Packages host binaries (bookclerk, bookclerkd, helpers) into artifacts.
package_platform function Packages platform-only guests (sqlite / local) into artifacts.
stage_desktop_runtime function Stages the host runtime the desktop app's packages carry.
tauri_build_command function The cargo tauri build call that bundles the desktop app with the packaging configs, run in the desktop crate.
DESKTOP_RUNTIME_STAGE constant Where stage_desktop_runtime puts the desktop app's runtime, under target/. crates/bookclerk-desktop/tauri.packaging.json bundles this folder as the app's runtime/ resource.

Functions

host_target_triple

pub fn host_target_triple() -> &'static str

Host rustc target triple for the machine running the packager.

Prefer bookclerk_target for new archive filenames. This remains for callers that still speak rustc triples; normalize_bookclerk_target maps either form onto a Bookclerk target name.

bookclerk_target

pub fn bookclerk_target() -> &'static str

Canonical Bookclerk artifact target for the host (e.g. linux-x64-gnu).

normalize_bookclerk_target

pub fn normalize_bookclerk_target(triple_or_target: &str) -> Option<&'static str>

Map a Bookclerk target or legacy rustc triple to a Bookclerk target name.

Arguments

  • triple_or_target - String triple_or_target for this call.

Returns

Some(...) when found / applicable; otherwise None.

uses_zip_archive

pub fn uses_zip_archive(triple_or_target: &str) -> bool

Whether archives for this Bookclerk target (or rustc triple) use .zip.

Arguments

  • triple_or_target - String triple_or_target for this call.

Returns

true when the predicate holds.

package_plugins

pub fn package_plugins(root: &Path, out_dir: &Path, version: &str) -> Result<()>

Packages discovered plugin guests into the release artifacts directory.

Arguments

  • root - Cargo workspace root directory.
  • out_dir - Filesystem path (out_dir).
  • version - String version for this call.

Returns

The successful result value for this operation.

Errors

Returns an error when the underlying I/O, parse, network, or store operation fails.

Panics

Panics when an internal invariant does not hold.

package_hosts

pub fn package_hosts(root: &Path, out_dir: &Path, version: &str) -> Result<()>

Packages host binaries (bookclerk, bookclerkd, helpers) into artifacts.

Arguments

  • root - Cargo workspace root directory.
  • out_dir - Filesystem path (out_dir).
  • version - String version for this call.

Returns

The successful result value for this operation.

Errors

Returns an error when the underlying I/O, parse, network, or store operation fails.

Panics

Panics when an internal invariant does not hold.

package_platform

pub fn package_platform(root: &Path, out_dir: &Path, version: &str) -> Result<()>

Packages platform-only guests (sqlite / local) into artifacts.

Arguments

  • root - Cargo workspace root directory.
  • out_dir - Filesystem path (out_dir).
  • version - String version for this call.

Returns

The successful result value for this operation.

Errors

Returns an error when the underlying I/O, parse, network, or store operation fails.

Panics

Panics when an internal invariant does not hold.

stage_desktop_runtime

pub fn stage_desktop_runtime(root: &Path, version: &str) -> Result<PathBuf>

Stages the host runtime the desktop app's packages carry.

Builds the platform bundle ([package_platform]: release helpers, workerd and the platform plugins), adds the web app (ui/dist), and leaves the result in target/desktop-runtime/, where the packaging config picks it up. The bundle's install ledger and lock are dropped, as the container image does: the app's files directory keeps its own. So are the bookclerk and bookclerkd binaries: the app runs the host in-process, and nothing would put them on the PATH.

Arguments

  • root - Cargo workspace root directory.
  • version - Version stamped into the platform plugins' receipts.

Returns

The staged runtime directory.

Errors

Returns an error when the platform bundle, the web app or a copy fails, or the staged runtime lacks a helper the desktop app needs.

tauri_build_command

pub fn tauri_build_command(root: &Path) -> Command

The cargo tauri build call that bundles the desktop app with the packaging configs, run in the desktop crate.

Arguments

  • root - Cargo workspace root directory.

Returns

The command, not yet run.

Constants

DESKTOP_RUNTIME_STAGE

pub const DESKTOP_RUNTIME_STAGE: &str = "desktop-runtime";

Where stage_desktop_runtime puts the desktop app's runtime, under target/. crates/bookclerk-desktop/tauri.packaging.json bundles this folder as the app's runtime/ resource.

Generated from crates/bookclerk-dev at main · View as Markdown