Struct RemoteDefaultBranch 

pub struct RemoteDefaultBranch { /* private fields */ }

Get the default branch of a remote.

Connects to the remote and reads the branch its HEAD points to.

Examples

use ironflow_ops_git::fetch::RemoteDefaultBranch;
use ironflow_core::operation::Operation;

let op = RemoteDefaultBranch::new("/path/to/repo", "origin");
assert_eq!(op.kind(), "git");

Implementations

impl RemoteDefaultBranch

pub fn new( repo_path: impl Into<PathBuf>, remote_name: impl Into<String>, ) -> Self

Create a new default-branch query operation.

pub async fn run( &self, ctx: &OperationContext, ) -> Result<RemoteDefaultBranchOutput, OperationError>

Execute and return a typed result.

Errors

Returns OperationError::Secret if the secret store fails, and OperationError::External if the connection fails or the remote has no default branch. The token never appears in the message.

impl RemoteDefaultBranch

pub fn token_secret(self, key: impl Into<String>) -> Self

Read the HTTPS token from the secret key instead of git_token.

Examples

use ironflow_ops_git::fetch::RemoteDefaultBranch;

let op = RemoteDefaultBranch::new("/path/to/repo", "origin").token_secret("gitlab_token");

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

Send name as the username with the token instead of oauth2.

Examples

use ironflow_ops_git::fetch::RemoteDefaultBranch;

let op = RemoteDefaultBranch::new("/path/to/repo", "origin").username("x-access-token");

Trait Implementations

impl Operation for RemoteDefaultBranch

fn kind(&self) -> &str

A short, lowercase identifier for this operation type.

fn execute<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 OperationContext, ) -> Pin<Box<dyn Future<Output = Result<Value, OperationError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Execute the operation and return the result as JSON.

fn input(&self) -> Option<Value>

Optional JSON representation of the operation input, stored in the step’s input column for observability.

impl TypedOperation for RemoteDefaultBranch

type Output = RemoteDefaultBranchOutput

The concrete output type that Operation::execute produces.