Skip to main content

BuildConfig

Struct BuildConfig 

Source
pub struct BuildConfig {
    pub base_image: String,
    pub runtime_image: String,
    pub extra_packages: Vec<String>,
    pub cargo_chef_version: String,
    pub include: Option<Vec<String>>,
    pub env: HashMap<String, String>,
}
Expand description

Build configuration under [build].

Controls Docker image generation and runtime content.

§Bundle strategy

By default, propel deploy bundles all files in the git repository (respecting .gitignore) into the Docker build context. This mirrors the git clone + docker build mental model used by GitHub Actions and similar CI/CD systems.

The bundle is created via git ls-files, so:

  • Tracked and untracked (non-ignored) files are included
  • .gitignored files (e.g. target/) are excluded
  • .propel-bundle/, .propel/, .git/ are always excluded

§Runtime content control

The include field controls what goes into the final runtime image:

  • include omitted (default): the entire bundle is copied into the runtime container via COPY . .. Zero config — migrations, templates, static assets all work automatically.

  • include specified: only the listed paths (plus the compiled binary) are copied into the runtime image. This acts as a lightweight alternative to propel eject for users who want smaller images.

§Escalation path

Zero config  →  include/env  →  propel eject
(all-in)        (selective)      (full Dockerfile control)

Fields§

§base_image: String

Rust builder image (default: rust:1.93-bookworm).

Must be ≥ 1.85 for edition = "2024" support.

§runtime_image: String

Runtime base image (default: gcr.io/distroless/cc-debian12).

§extra_packages: Vec<String>

Additional system packages to install via apt-get during build.

§cargo_chef_version: String

Cargo Chef version for dependency caching.

§include: Option<Vec<String>>

Paths to copy into the runtime image.

When None, the entire bundle is copied (COPY . .). When Some, only these paths are copied — overriding the all-in default.

[build]
include = ["migrations/", "templates/"]
§env: HashMap<String, String>

Static environment variables baked into the container image.

These become ENV directives in the generated Dockerfile. For runtime-configurable values (API keys, secrets), use Cloud Run environment variables or Secret Manager instead.

[build.env]
TEMPLATE_DIR = "/app/templates"

Trait Implementations§

Source§

impl Clone for BuildConfig

Source§

fn clone(&self) -> BuildConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BuildConfig

Source§

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

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

impl Default for BuildConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for BuildConfig

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 Serialize for BuildConfig

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> 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> 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
Source§

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