Struct CreateCheckRunArgs

pub struct CreateCheckRunArgs {
    pub name: CheckRunName,
    pub head_sha: GitSha,
    pub details_url: Option<Url>,
    pub external_id: Option<String>,
    pub status: Option<CheckRunStatus>,
    pub started_at: Option<DateTime<Utc>>,
    pub conclusion: Option<CheckRunConclusion>,
    pub completed_at: Option<DateTime<Utc>>,
    pub output: Option<CheckRunOutputArgs>,
}

Input for create check run task

The input for the task that creates a check run represents the different parameters that GitHub’s API accepts.

https://docs.github.com/en/rest/checks/runs#create-a-check-run

Fields

name: CheckRunName

The name of the check. For example, “code-coverage”.

head_sha: GitSha

The SHA of the commit.

details_url: Option<Url>

The URL of the integrator’s site that has the full details of the check. If the integrator does not provide this, then the homepage of the GitHub app is used.

external_id: Option<String>

A reference for the run on the integrator’s system.

status: Option<CheckRunStatus>

The current status. queued by default.

started_at: Option<DateTime<Utc>>

The time that the check run began.

conclusion: Option<CheckRunConclusion>

The final conclusion of the check.

Required if you provide completed_at or a status of completed. Providing a conclusion will automatically set the status parameter to completed. You cannot change a check run conclusion to stale, only GitHub can set this.

completed_at: Option<DateTime<Utc>>

The time the check completed.

output: Option<CheckRunOutputArgs>

Check runs can accept a variety of data in the output object, including a title and summary and can optionally provide descriptive details about the run.

Trait Implementations

impl Clone for CreateCheckRunArgs

fn clone(&self) -> CreateCheckRunArgs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCheckRunArgs

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

Formats the value using the given formatter.

impl Hash for CreateCheckRunArgs

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CreateCheckRunArgs

fn cmp(&self, other: &CreateCheckRunArgs) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CreateCheckRunArgs

fn eq(&self, other: &CreateCheckRunArgs) -> 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 PartialOrd for CreateCheckRunArgs

fn partial_cmp(&self, other: &CreateCheckRunArgs) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CreateCheckRunArgs

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CreateCheckRunArgs

impl StructuralPartialEq for CreateCheckRunArgs