Skip to main content

AppImageConfig

Struct AppImageConfig 

Source
pub struct AppImageConfig {
Show 13 fields pub id: Option<String>, pub ids: Option<Vec<String>>, pub filename: Option<String>, pub name: Option<String>, pub desktop: Option<String>, pub icon: Option<String>, pub appdir_extra: Option<Vec<AppImageExtra>>, pub update_information: Option<String>, pub runtime_harvest: Option<RuntimeHarvest>, pub extra_args: Option<Vec<String>>, pub os: Option<Vec<String>>, pub arch: Option<Vec<String>>, pub skip: Option<StringOrBool>,
}
Expand description

AppImage packaging configuration.

Drives the AppImage stage, which bundles a built Linux binary plus its desktop integration (a .desktop entry + icon) into a single self-contained, runnable .AppImage file via linuxdeploy’s appimage output plugin. One .AppImage is produced per matching Linux target so a multi-arch build yields distinct, non-colliding outputs.

YAML:

appimages:
  - id: helix
    ids: [helix-bin]
    desktop: contrib/Helix.desktop
    icon: contrib/helix.png
    appdir_extra:
      - src: runtime/
        dst: usr/lib/helix/runtime
    update_information: "gh-releases-zsync|helix-editor|helix|latest|helix-*.AppImage.zsync"
    runtime_harvest:
      command: "{{ ArtifactPath }} --populate-runtime {{ HarvestDir }}"
      dir: runtime/

Fields§

§id: Option<String>

Unique identifier for this AppImage config (default: “default”).

§ids: Option<Vec<String>>

Build IDs filter: only bundle binaries whose id is in this list. When omitted, every Linux binary in the build matrix is eligible.

§filename: Option<String>

Output filename template (default includes project, version, os, arch). The .AppImage extension is appended automatically when absent.

§name: Option<String>

Application name passed to linuxdeploy via the APP env var and used as the AppDir basename. Defaults to the project name.

§desktop: Option<String>

Path to the .desktop entry file (template). Required — linuxdeploy will not assemble an AppImage without a desktop file.

§icon: Option<String>

Path to the application icon (template). Required.

§appdir_extra: Option<Vec<AppImageExtra>>

Extra files / directories copied into the AppDir before linuxdeploy runs (e.g. a harvested runtime/ tree). Each entry’s dst is interpreted relative to the AppDir root.

§update_information: Option<String>

zsync delta-update metadata embedded in the AppImage, passed to linuxdeploy via the UPDATE_INFORMATION env var. When omitted, the AppImage carries no update information and UPDATE_INFORMATION is left unset (matching linuxdeploy’s default).

§runtime_harvest: Option<RuntimeHarvest>

Runtime-asset harvest hook: run the freshly-built binary ONCE on the host to populate a directory, then bundle that directory into the AppDir. The harvested data is architecture-independent (grammars, themes, queries), so it is produced once on the host-native binary and reused for every target’s AppImage.

§extra_args: Option<Vec<String>>

Extra arguments appended to the linuxdeploy command line.

§os: Option<Vec<String>>

Target OS filter (default: [“linux”]). AppImage is a Linux-only format.

§arch: Option<Vec<String>>

Target architecture filter. When omitted, every architecture in the build matrix produces its own .AppImage.

§skip: Option<StringOrBool>

Skip this config. Accepts bool or template string.

Trait Implementations§

Source§

impl Clone for AppImageConfig

Source§

fn clone(&self) -> AppImageConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AppImageConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for AppImageConfig

Source§

fn default() -> AppImageConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for AppImageConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for AppImageConfig

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl Serialize for AppImageConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more