Update an environment variable

Updates an environment variable that you can reference in a GitHub Actions workflow. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `environment:write` repository permission to use this endpoint.

Script github Verified

by hugo697 ยท 10/25/2023

The script

Submitted by hugo697 Typescript (fetch-only)
Verified 367 days ago
1
type Github = {
2
  token: string;
3
};
4
/**
5
 * Update an environment variable
6
 * Updates an environment variable that you can reference in a GitHub Actions workflow.
7
You must authenticate using an access token with the `repo` scope to use this endpoint.
8
GitHub Apps must have the `environment:write` repository permission to use this endpoint.
9
 */
10
export async function main(
11
  auth: Github,
12
  repository_id: string,
13
  name: string,
14
  environment_name: string,
15
  body: { name?: string; value?: string; [k: string]: unknown }
16
) {
17
  const url = new URL(
18
    `https://api.github.com/repositories/${repository_id}/environments/${environment_name}/variables/${name}`
19
  );
20

21
  const response = await fetch(url, {
22
    method: "PATCH",
23
    headers: {
24
      "Content-Type": "application/json",
25
      Authorization: "Bearer " + auth.token,
26
    },
27
    body: JSON.stringify(body),
28
  });
29
  if (!response.ok) {
30
    const text = await response.text();
31
    throw new Error(`${response.status} ${text}`);
32
  }
33
  return await response.text();
34
}
35