Skip to main content

GitHubActionsEmitter

Struct GitHubActionsEmitter 

Source
pub struct GitHubActionsEmitter {
    pub runner: String,
    pub use_nix: bool,
    pub use_cachix: bool,
    pub cachix_name: Option<String>,
    pub cachix_auth_token_secret: String,
    pub default_paths_ignore: Vec<String>,
    pub build_cuenv: bool,
    pub approval_environment: String,
    pub configured_permissions: HashMap<String, String>,
}
Expand description

GitHub Actions workflow emitter

Transforms cuenv IR into GitHub Actions workflow YAML that can be committed to .github/workflows/.

§IR to GitHub Actions Mapping

IR FieldGitHub Actions
pipeline.nameWorkflow name:
pipeline.trigger.branchon.push.branches / on.pull_request.branches
task.idJob key
task.commandStep with run: cuenv task {task.id}
task.depends_onJob needs:
task.manual_approvalJob with environment:
task.concurrency_groupJob-level concurrency:
task.resources.tagsruns-on:
task.outputs (orchestrator)actions/upload-artifact step

Fields§

§runner: String

Default runner for jobs

§use_nix: bool

Include Nix installation steps

§use_cachix: bool

Include Cachix caching steps

§cachix_name: Option<String>

Cachix cache name

§cachix_auth_token_secret: String

Cachix auth token secret name

§default_paths_ignore: Vec<String>

Default paths to ignore in triggers

§build_cuenv: bool

Include cuenv build step (via nix build)

§approval_environment: String

Environment name for manual approval tasks

§configured_permissions: HashMap<String, String>

Configured permissions from the manifest

Implementations§

Source§

impl GitHubActionsEmitter

Source

pub fn new() -> Self

Create a new GitHub Actions emitter with default settings

Source

pub fn from_config(config: &GitHubConfig) -> Self

Create an emitter from a GitHubConfig manifest configuration.

This applies all configuration from the CUE manifest to the emitter.

Source

pub fn runner_as_runs_on(&self) -> RunsOn

Get the configured runner as a RunsOn value

Source

pub fn apply_configured_permissions( &self, permissions: Permissions, ) -> Permissions

Apply configured permissions to a base Permissions struct

Source

pub fn with_runner(self, runner: impl Into<String>) -> Self

Set the default runner for jobs

Source

pub const fn with_nix(self) -> Self

Enable Nix installation steps

Source

pub const fn without_nix(self) -> Self

Disable Nix installation steps

Source

pub fn with_cachix(self, name: impl Into<String>) -> Self

Enable Cachix caching with the given cache name

Source

pub fn with_cachix_auth_token_secret(self, secret: impl Into<String>) -> Self

Set the Cachix auth token secret name

Source

pub fn with_paths_ignore(self, paths: Vec<String>) -> Self

Set default paths to ignore in triggers

Source

pub const fn without_cuenv_build(self) -> Self

Disable automatic cuenv build step

Source

pub fn with_approval_environment(self, env: impl Into<String>) -> Self

Set the environment name for manual approval tasks

Source

pub fn emit_workflows( &self, ir: &IntermediateRepresentation, ) -> EmitterResult<HashMap<String, String>>

Emit multiple workflow files for projects with multiple pipelines.

Returns a map of filename to YAML content. Each pipeline in the IR generates a separate workflow file.

§Errors

Returns EmitterError::Serialization if YAML serialization fails.

Source

pub fn render_phase_steps( ir: &IntermediateRepresentation, ) -> (Vec<Step>, IndexMap<String, String>)

Render phase tasks (bootstrap + setup) into GitHub Actions steps.

Returns a tuple of:

  • Vec<Step> - rendered steps for bootstrap and setup phase tasks
  • IndexMap<String, String> - secret env vars that should be passed to task steps

This uses GitHubStageRenderer to properly convert phase tasks into steps, handling both uses: action steps and run: command steps.

Source

pub fn build_simple_job( &self, task: &Task, ir: &IntermediateRepresentation, environment: Option<&String>, project_path: Option<&str>, ) -> Job

Build a simple job from an IR task (no matrix expansion).

This method creates a single job that:

  1. Checks out the repository
  2. Runs bootstrap/setup phase tasks (Nix, cuenv, 1Password, etc.)
  3. Runs the task with --skip-dependencies (since CI handles job dependencies)

Use build_matrix_jobs for tasks with matrix configurations.

§Arguments
  • task - IR task to build job for
  • ir - Intermediate representation containing phase tasks
  • environment - Optional environment name for the task
  • project_path - Optional working directory (for monorepo projects)
Source

pub fn build_artifact_aggregation_job( &self, task: &Task, ir: &IntermediateRepresentation, environment: Option<&String>, previous_jobs: &[String], project_path: Option<&str>, ) -> Job

Build an artifact aggregation job from an IR task with artifact_downloads.

This creates a job that:

  1. Checks out the repository
  2. Runs bootstrap/setup phase tasks
  3. Downloads artifacts from previous jobs
  4. Runs the task with params and --skip-dependencies

Use this for tasks that aggregate outputs from matrix jobs (e.g., publish).

§Arguments
  • task - IR task to build job for
  • ir - Intermediate representation containing phase tasks
  • environment - Optional environment name for the task
  • previous_jobs - Jobs that must complete before this job
  • project_path - Optional working directory (for monorepo projects)
Source

pub fn build_matrix_jobs( &self, task: &Task, ir: &IntermediateRepresentation, environment: Option<&String>, arch_runners: Option<&HashMap<String, String>>, previous_jobs: &[String], project_path: Option<&str>, ) -> IndexMap<String, Job>

Build matrix-expanded jobs from an IR task with matrix configuration.

This expands a single task into multiple jobs, one per matrix combination. Currently supports single-dimension matrix expansion (arch).

Returns an IndexMap of job_id -> Job for each matrix combination.

§Arguments
  • task - IR task with matrix configuration
  • ir - Intermediate representation containing phase tasks
  • environment - Optional environment name for the task
  • arch_runners - Optional mapping of arch -> runner label
  • previous_jobs - Jobs that must complete before these matrix jobs
  • project_path - Optional working directory (for monorepo projects)
Source

pub fn task_has_matrix(task: &Task) -> bool

Check if a task has matrix configuration.

Source

pub const fn task_has_artifact_downloads(task: &Task) -> bool

Check if a task has artifact downloads (aggregation task).

Trait Implementations§

Source§

impl Clone for GitHubActionsEmitter

Source§

fn clone(&self) -> GitHubActionsEmitter

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 GitHubActionsEmitter

Source§

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

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

impl Default for GitHubActionsEmitter

Source§

fn default() -> Self

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

impl Emitter for GitHubActionsEmitter

Source§

fn emit_thin(&self, ir: &IntermediateRepresentation) -> EmitterResult<String>

Emit a thin mode GitHub Actions workflow.

Thin mode generates a single-job workflow that:

  1. Runs bootstrap phase steps (e.g., install Nix)
  2. Runs setup phase steps (e.g., build cuenv)
  3. Executes cuenv ci --pipeline <name> for orchestration
  4. Runs success/failure phase steps with conditions
Source§

fn emit_expanded( &self, ir: &IntermediateRepresentation, ) -> EmitterResult<String>

Emit an expanded mode GitHub Actions workflow.

Expanded mode generates a multi-job workflow where each task becomes a separate job with dependencies managed by GitHub Actions (needs:).

Source§

fn format_name(&self) -> &'static str

Get the format identifier for this emitter Read more
Source§

fn file_extension(&self) -> &'static str

Get the file extension for output files Read more
Source§

fn description(&self) -> &'static str

Get a human-readable description of this emitter
Source§

fn validate(&self, ir: &IntermediateRepresentation) -> EmitterResult<()>

Validate the IR before emission Read more
Source§

fn emit(&self, ir: &IntermediateRepresentation) -> Result<String, EmitterError>

Emit a CI configuration based on the mode in the IR. 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> GetSetFdFlags for T

Source§

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.
Source§

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more
Source§

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: AsFilelike,

Set the “status” flags for the self file descriptor. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Pointer = u32

Source§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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