GitHubSecret

The GitHubSecret resource lets you manage GitHub Actions secrets in your repositories.

Minimal Example

Create a secret in a GitHub repository using the GITHUB_TOKEN environment variable:

import { GitHubSecret } from "alchemy/github";

const secret = await GitHubSecret("api-key", {
  owner: "my-github-username", 
  repository: "my-repo",
  name: "API_KEY",
  value: alchemy.secret("my-secret-value")
});

Custom Token

Create a secret using a custom GitHub token:

import { GitHubSecret } from "alchemy/github";

const secret = await GitHubSecret("deploy-token", {
  owner: "my-github-username",
  repository: "my-repo", 
  name: "DEPLOY_TOKEN",
  value: alchemy.secret("my-secret-value"),
  token: alchemy.secret(process.env.CUSTOM_GITHUB_TOKEN)
});

Multiple Secrets

Create multiple secrets in a repository:

import { GitHubSecret } from "alchemy/github";

const secrets = await Promise.all([
  GitHubSecret("aws-secret", {
    owner: "my-github-username",
    repository: "cloud-app",
    name: "AWS_ROLE_ARN", 
    value: alchemy.secret(process.env.AWS_ROLE_ARN)
  }),
  GitHubSecret("cf-secret", {
    owner: "my-github-username", 
    repository: "cloud-app",
    name: "CLOUDFLARE_API_KEY",
    value: alchemy.secret(process.env.CLOUDFLARE_API_KEY)
  })
]);