Struct PrCreateCommand 

pub struct PrCreateCommand { /* private fields */ }

Command for creating a pull request

Implementations

impl PrCreateCommand

pub fn title(self, title: &str) -> Self

Set the PR title

Examples found in repository

examples/pr.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = GhClient::new();

    println!("Creating a pull request...");
    match client
        .pr()
        .create()
        .title("test PR created by gh_cli_rs")
        .body("This PR adds a new feature\n\n## Changes\n- Added feature X\n- Fixed bug Y")
        // the branches must exist in remote repo for the command to work
        .base("main")
        .head("feature-branch")
        .draft()
        .execute()
    {
        Ok(result) => println!("✓ PR created: {}", result),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    println!("\n🔍 Viewing PR #1:");
    match client.pr().view(1).execute() {
        Ok(pr) => println!("{}", pr),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    Ok(())
}

pub fn body(self, body: &str) -> Self

Set the PR body

Examples found in repository

examples/pr.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = GhClient::new();

    println!("Creating a pull request...");
    match client
        .pr()
        .create()
        .title("test PR created by gh_cli_rs")
        .body("This PR adds a new feature\n\n## Changes\n- Added feature X\n- Fixed bug Y")
        // the branches must exist in remote repo for the command to work
        .base("main")
        .head("feature-branch")
        .draft()
        .execute()
    {
        Ok(result) => println!("✓ PR created: {}", result),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    println!("\n🔍 Viewing PR #1:");
    match client.pr().view(1).execute() {
        Ok(pr) => println!("{}", pr),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    Ok(())
}

pub fn base(self, base: &str) -> Self

Set the base branch

Examples found in repository

examples/pr.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = GhClient::new();

    println!("Creating a pull request...");
    match client
        .pr()
        .create()
        .title("test PR created by gh_cli_rs")
        .body("This PR adds a new feature\n\n## Changes\n- Added feature X\n- Fixed bug Y")
        // the branches must exist in remote repo for the command to work
        .base("main")
        .head("feature-branch")
        .draft()
        .execute()
    {
        Ok(result) => println!("✓ PR created: {}", result),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    println!("\n🔍 Viewing PR #1:");
    match client.pr().view(1).execute() {
        Ok(pr) => println!("{}", pr),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    Ok(())
}

pub fn head(self, head: &str) -> Self

Set the head branch

Examples found in repository

examples/pr.rs (line 14)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = GhClient::new();

    println!("Creating a pull request...");
    match client
        .pr()
        .create()
        .title("test PR created by gh_cli_rs")
        .body("This PR adds a new feature\n\n## Changes\n- Added feature X\n- Fixed bug Y")
        // the branches must exist in remote repo for the command to work
        .base("main")
        .head("feature-branch")
        .draft()
        .execute()
    {
        Ok(result) => println!("✓ PR created: {}", result),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    println!("\n🔍 Viewing PR #1:");
    match client.pr().view(1).execute() {
        Ok(pr) => println!("{}", pr),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    Ok(())
}

pub fn draft(self) -> Self

Mark as draft

Examples found in repository

examples/pr.rs (line 15)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = GhClient::new();

    println!("Creating a pull request...");
    match client
        .pr()
        .create()
        .title("test PR created by gh_cli_rs")
        .body("This PR adds a new feature\n\n## Changes\n- Added feature X\n- Fixed bug Y")
        // the branches must exist in remote repo for the command to work
        .base("main")
        .head("feature-branch")
        .draft()
        .execute()
    {
        Ok(result) => println!("✓ PR created: {}", result),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    println!("\n🔍 Viewing PR #1:");
    match client.pr().view(1).execute() {
        Ok(pr) => println!("{}", pr),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    Ok(())
}

pub fn web(self) -> Self

Open in web browser

pub fn execute(&self) -> Result<String>

Execute the create command

Examples found in repository

examples/pr.rs (line 16)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = GhClient::new();

    println!("Creating a pull request...");
    match client
        .pr()
        .create()
        .title("test PR created by gh_cli_rs")
        .body("This PR adds a new feature\n\n## Changes\n- Added feature X\n- Fixed bug Y")
        // the branches must exist in remote repo for the command to work
        .base("main")
        .head("feature-branch")
        .draft()
        .execute()
    {
        Ok(result) => println!("✓ PR created: {}", result),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    println!("\n🔍 Viewing PR #1:");
    match client.pr().view(1).execute() {
        Ok(pr) => println!("{}", pr),
        Err(e) => eprintln!("✗ Error: {}", e),
    }

    Ok(())
}

Trait Implementations

impl GhCommand for PrCreateCommand

fn build_args(&self) -> Vec<String>

Build the command arguments

fn execute(&self, executor: &GhExecutor) -> Result<String>

Execute the command and return raw string output