actions-toolkit-sys 0.1.0

Raw bindings to the GitHub actions toolkit API for projects using wasm-bindgen. 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

//! Raw bindings to the GitHub actions toolkit API for projects using wasm-bindgen.

#![deny(clippy::all)]
#![deny(missing_docs)]

use js_sys::{Function, JsString, Object, Promise};
use wasm_bindgen::prelude::*;

#[wasm_bindgen(module = "@actions/core")]
extern {
    #[wasm_bindgen(js_name = "issue")]
    pub fn issue(name: JsString, message: Option<JsString>);

    #[wasm_bindgen(js_name = "issueCommand")]
    pub fn issue_command(command: JsString, properties: &Object, message: JsString);
}

/// Interface for getInput options
#[wasm_bindgen]
pub struct InputOptions {
    /// Whether the input is required. If required and not present, will throw. Defaults
    /// to false.
    pub required: Option<bool>,
}

/// The code to exit an action
#[wasm_bindgen]
pub enum ExitCode {
    /// A code indicating that the action was successful
    Success,
    /// A code indicating that the action was a failure
    Failure,
}

#[wasm_bindgen(module = "@actions/core")]
extern {
    /// Sets env variable for this action and future actions in the job.
    #[wasm_bindgen(js_name = "exportVariable")]
    pub fn export_variable(name: JsString, value: JsString);

    /// Exports the variable and registers a secret which will get masked from logs.
    #[wasm_bindgen(js_name = "exportSecret")]
    pub fn export_secret(name: JsString, value: JsString);

    /// Prepends inputPath to the PATH (for this action and future actions).
    #[wasm_bindgen(js_name = "addPath")]
    pub fn add_path(path: JsString);

    /// Gets the value of an input. The value is also trimmed.
    #[wasm_bindgen(js_name = "getInput")]
    pub fn get_input(name: JsString, options: Option<InputOptions>) -> JsString;

    /// Sets the value of an output.
    #[wasm_bindgen(js_name = "setOutput")]
    pub fn set_output(name: JsString, value: JsString);

    /// Sets the action status to failed. When the action exits it will be with an exit code of 1.
    #[wasm_bindgen(js_name = "setFailed")]
    pub fn set_failed(message: JsString);

    /// Writes debug message to user log.
    #[wasm_bindgen]
    pub fn debug(message: JsString);

    /// Adds an error issue.
    #[wasm_bindgen]
    pub fn error(message: JsString);

    /// Adds an warning issue.
    #[wasm_bindgen]
    pub fn warning(message: JsString);

    /// Writes info to log with console.log.
    #[wasm_bindgen]
    pub fn info(message: JsString);

    /// Begin an output group.
    #[wasm_bindgen(js_name = "startGroup")]
    pub fn start_group(name: JsString);

    /// End an output group.
    #[wasm_bindgen(js_name = "endGroup")]
    pub fn end_group();

    /// Wrap an asynchronous function call in a group.
    #[wasm_bindgen]
    pub fn group(name: JsString, fun: &Function) -> Promise;
}