automatons_github/task/
mod.rs

1//! Tasks for the GitHub
2//!
3//! The GitHub integration implements tasks that can be used to create automatons.
4
5use serde::Serialize;
6
7use crate::resource::{CheckRunOutputSummary, CheckRunOutputTitle};
8
9pub use self::create_check_run::{CreateCheckRun, CreateCheckRunArgs};
10pub use self::get_file::GetFile;
11pub use self::list_check_runs_for_check_suite::ListCheckRunsForCheckSuite;
12pub use self::list_check_runs_for_git_sha::ListCheckRunsForGitSha;
13pub use self::list_check_suites::ListCheckSuites;
14pub use self::update_check_run::{UpdateCheckRun, UpdateCheckRunArgs};
15
16mod create_check_run;
17mod get_file;
18mod list_check_runs_for_check_suite;
19mod list_check_runs_for_git_sha;
20mod list_check_suites;
21mod update_check_run;
22
23/// Input for check run output
24///
25/// Check runs can accept a variety of data in the `output` object, including a `title` and
26/// `summary` and can optionally provide descriptive details about the run.
27///
28/// https://docs.github.com/en/rest/checks/runs#update-a-check-run
29#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Serialize)]
30pub struct CheckRunOutputArgs {
31    /// The title of the check run output.
32    pub title: CheckRunOutputTitle,
33
34    /// The summary of the check run output.
35    pub summary: CheckRunOutputSummary,
36
37    /// The text with descriptive details about the check run.
38    #[serde(skip_serializing_if = "Option::is_none")]
39    pub text: Option<String>,
40}