Struct ReposCreateDeploymentRequest

pub struct ReposCreateDeploymentRequest {
    pub ref: String,
    pub task: Option<String>,
    pub auto_merge: Option<bool>,
    pub required_contexts: Option<Vec<String>>,
    pub payload: Option<Box<ReposCreateDeploymentRequestPayload>>,
    pub environment: Option<String>,
    pub description: Option<Option<String>>,
    pub transient_environment: Option<bool>,
    pub production_environment: Option<bool>,
}

Fields

ref: String

The ref to deploy. This can be a branch, tag, or SHA.

task: Option<String>

Specifies a task to execute (e.g., deploy or deploy:migrations).

auto_merge: Option<bool>

Attempts to automatically merge the default branch into the requested ref, if it’s behind the default branch.

required_contexts: Option<Vec<String>>

The status contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.

payload: Option<Box<ReposCreateDeploymentRequestPayload>>

environment: Option<String>

Name for the target deployment environment (e.g., production, staging, qa).

description: Option<Option<String>>

Short description of the deployment.

transient_environment: Option<bool>

Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: false

production_environment: Option<bool>

Specifies if the given environment is one that end-users directly interact with. Default: true when environment is production and false otherwise.

Implementations

impl ReposCreateDeploymentRequest

pub fn new(ref: String) -> ReposCreateDeploymentRequest

Trait Implementations

impl Clone for ReposCreateDeploymentRequest

fn clone(&self) -> ReposCreateDeploymentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReposCreateDeploymentRequest

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

Formats the value using the given formatter.

impl Default for ReposCreateDeploymentRequest

fn default() -> ReposCreateDeploymentRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReposCreateDeploymentRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ReposCreateDeploymentRequest

fn eq(&self, other: &ReposCreateDeploymentRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ReposCreateDeploymentRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ReposCreateDeploymentRequest