Enum Request

pub enum Request {
    CheckoutRepo {
        repo_id: ReadVar<String>,
        repo_path: WriteVar<PathBuf>,
        persist_credentials: bool,
    },
    RegisterRepo {
        repo_id: String,
        repo_src: RepoSource,
        allow_persist_credentials: bool,
        depth: Option<usize>,
        pre_run_deps: Vec<ReadVar<SideEffect>>,
    },
    LocalOnlyRequireExistingClones(bool),
}

Variants

CheckoutRepo

Checkout a repo, returning a path to the repo.

Checking out the same repo multiple times will result in unique clones on each invocation.

Notice: unlike the checkout steps you might be familiar with in ADO or GH Actions, the details of how / where the repo is checked out are decoupled from the having nodes get a handle to a checked out repo’s path.

This is because the specifics of how / where the repo is checked out vary depending on the flow’s deployment context, and are therefore provided separately via the Request::RegisterRepo request (typically via a top-level job node).

Fields

repo_id: ReadVar<String>

ad-hoc string used to correlate this CheckoutRepo request with its corresponding RegisterRepo request.

repo_path: WriteVar<PathBuf>

Path to the cloned repo

persist_credentials: bool

In CI: whether the cloned repo should persist credentials post-clone.

RegisterRepo

Specify the details of how to check out a particular repo_id.

Fields

repo_id: String

ad-hoc string used to correlate this RegisterRepo request with its corresponding CheckoutRepo request.

repo_src: RepoSource

How the repo should be cloned

allow_persist_credentials: bool

In CI: whether checkout requests for this repo should be allowed to persist credentials post-clone.

NOTE: in order to avoid accidentally giving credentials to flows that didn’t explicitly request them ,flowey requires that a repo cloned with persistent credentials to be registered under a separate repo_id than the repo without persistent credentials.

depth: Option<usize>

The fetch depth of the checkout. If None, the entire history is checked out.

pre_run_deps: Vec<ReadVar<SideEffect>>

LocalOnlyRequireExistingClones(bool)

When running locally: whether or not all repos should be cloned locally ahead of time, vs. re-cloning them.

Trait Implementations

impl<'de> Deserialize<'de> for Request

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoRequest for Request

type Node = Node

fn into_request(self) -> Request

impl Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.