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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
use http::StatusCode;
use super::RepoHandler;
use crate::models::repos::secrets::{CreateRepositorySecret, CreateRepositorySecretResponse};
/// A client to GitHub's repository secrets API.
///
/// Created with [`RepoHandler`].
pub struct RepoSecretsHandler<'octo> {
handler: &'octo RepoHandler<'octo>,
}
impl<'octo> RepoSecretsHandler<'octo> {
pub(crate) fn new(repo: &'octo RepoHandler<'octo>) -> Self {
Self { handler: repo }
}
/// Lists all secrets available in a repository without revealing their encrypted values.
/// You must authenticate using an access token with the `repo` scope to use this endpoint.
/// GitHub Apps must have the `secrets` repository permission to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// let all_secrets = octocrab.repos("owner", "repo")
/// .secrets()
/// .get_secrets()
/// .await?;
/// # Ok(())
/// # }
pub async fn get_secrets(
&self,
) -> crate::Result<crate::models::repos::secrets::RepositorySecrets> {
let route = format!("/{}/actions/secrets", self.handler.repo);
self.handler.crab.get(route, None::<&()>).await
}
/// Gets your public key, which you need to encrypt secrets.
/// You need to encrypt a secret before you can create or update secrets.
/// Anyone with read access to the repository can use this endpoint.
/// If the repository is private you must use an access token with the `repo` scope.
/// GitHub Apps must have the `secrets` repository permission to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// let public_key = octocrab.repos("owner", "repo")
/// .secrets()
/// .get_public_key()
/// .await?;
/// # Ok(())
/// # }
pub async fn get_public_key(&self) -> crate::Result<crate::models::PublicKey> {
let route = format!("/{}/actions/secrets/public-key", self.handler.repo);
self.handler.crab.get(route, None::<&()>).await
}
/// Gets a single repository secret without revealing its encrypted value.
/// You must authenticate using an access token with the `repo` scope to use this endpoint.
/// GitHub Apps must have the `secrets` repository permission to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// let secret_info = octocrab.repos("owner", "repo")
/// .secrets()
/// .get_secret("TOKEN")
/// .await?;
/// # Ok(())
/// # }
pub async fn get_secret(
&self,
secret_name: impl AsRef<str>,
) -> crate::Result<crate::models::repos::secrets::RepositorySecret> {
let route = format!(
"/{}/actions/secrets/{secret_name}",
self.handler.repo,
secret_name = secret_name.as_ref()
);
self.handler.crab.get(route, None::<&()>).await
}
/// Creates or updates a repository secret with an encrypted value.
/// Encrypt your secret using [`crypto_box`](https://crates.io/crates/crypto_box).
/// You must authenticate using an access token with the `repo` scope to use this endpoint.
/// GitHub Apps must have the `secrets` repository permission to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// use octocrab::models::repos::secrets::{CreateRepositorySecret, CreateRepositorySecretResponse};
///
/// let result = octocrab.repos("owner", "repo")
/// .secrets()
/// .create_or_update_secret("GH_TOKEN", &CreateRepositorySecret{
/// key_id: "123456",
/// encrypted_value: "some-b64-encrypted-string",
/// })
/// .await?;
///
/// match result {
/// CreateRepositorySecretResponse::Created => println!("Created secret!"),
/// CreateRepositorySecretResponse::Updated => println!("Updated secret!"),
/// }
/// # Ok(())
/// # }
pub async fn create_or_update_secret(
&self,
secret_name: impl AsRef<str>,
secret: &CreateRepositorySecret<'_>,
) -> crate::Result<CreateRepositorySecretResponse> {
let route = format!(
"/{}/actions/secrets/{secret_name}",
self.handler.repo,
secret_name = secret_name.as_ref()
);
let resp = {
let resp = self.handler.crab._put(route, Some(secret)).await?;
crate::map_github_error(resp).await?
};
match resp.status() {
StatusCode::CREATED => Ok(CreateRepositorySecretResponse::Created),
StatusCode::NO_CONTENT => Ok(CreateRepositorySecretResponse::Updated),
status_code => Err(crate::Error::Other {
source: format!(
"Unexpected status code from request: {}",
status_code.as_str()
)
.into(),
backtrace: snafu::Backtrace::capture(),
}),
}
}
/// Deletes a secret in an organization using the secret name.
/// You must authenticate using an access token with the `admin:org` scope to use this endpoint.
/// GitHub Apps must have the `secrets` organization permission to use this endpoint.
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// # let octocrab = octocrab::Octocrab::default();
/// let repo = octocrab.repos("owner", "repo")
/// .secrets()
/// .delete_secret("GH_TOKEN")
/// .await?;
///
/// # Ok(())
/// # }
pub async fn delete_secret(&self, secret_name: impl AsRef<str>) -> crate::Result<()> {
let route = format!(
"/{}/actions/secrets/{secret_name}",
self.handler.repo,
secret_name = secret_name.as_ref()
);
let resp = self.handler.crab._delete(route, None::<&()>).await?;
crate::map_github_error(resp).await?;
Ok(())
}
}