6ebe3612cd
All checks were successful
Test / frontend-tests (pull_request) Successful in 1m9s
Test / frontend-typecheck (pull_request) Successful in 1m15s
Test / rust-fmt-check (pull_request) Successful in 2m44s
Test / rust-clippy (pull_request) Successful in 24m22s
Test / rust-tests (pull_request) Successful in 25m43s
- Fix TypeScript lint errors in setup.ts and LogUpload - Remove unused imports and variables - Fix duplicate Separator exports in ui/index.tsx - Apply cargo fmt formatting to Rust code - Update ESLint configuration
124 lines
3.0 KiB
Groff
124 lines
3.0 KiB
Groff
.nh
|
|
.TH "GH-SECRET-SET" "1" "Nov 2024" "GitHub CLI 2.63.0" "GitHub CLI manual"
|
|
|
|
.SH NAME
|
|
gh-secret-set - Create or update secrets
|
|
|
|
|
|
.SH SYNOPSIS
|
|
\fBgh secret set <secret-name> [flags]\fR
|
|
|
|
|
|
.SH DESCRIPTION
|
|
Set a value for a secret on one of the following levels:
|
|
- repository (default): available to GitHub Actions runs or Dependabot in a repository
|
|
- environment: available to GitHub Actions runs for a deployment environment in a repository
|
|
- organization: available to GitHub Actions runs, Dependabot, or Codespaces within an organization
|
|
- user: available to Codespaces for your user
|
|
|
|
.PP
|
|
Organization and user secrets can optionally be restricted to only be available to
|
|
specific repositories.
|
|
|
|
.PP
|
|
Secret values are locally encrypted before being sent to GitHub.
|
|
|
|
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB-a\fR, \fB--app\fR \fB<string>\fR
|
|
Set the application for a secret: {actions|codespaces|dependabot}
|
|
|
|
.TP
|
|
\fB-b\fR, \fB--body\fR \fB<string>\fR
|
|
The value for the secret (reads from standard input if not specified)
|
|
|
|
.TP
|
|
\fB-e\fR, \fB--env\fR \fB<environment>\fR
|
|
Set deployment environment secret
|
|
|
|
.TP
|
|
\fB-f\fR, \fB--env-file\fR \fB<file>\fR
|
|
Load secret names and values from a dotenv-formatted file
|
|
|
|
.TP
|
|
\fB--no-store\fR
|
|
Print the encrypted, base64-encoded value instead of storing it on GitHub
|
|
|
|
.TP
|
|
\fB-o\fR, \fB--org\fR \fB<organization>\fR
|
|
Set organization secret
|
|
|
|
.TP
|
|
\fB-r\fR, \fB--repos\fR \fB<repositories>\fR
|
|
List of repositories that can access an organization or user secret
|
|
|
|
.TP
|
|
\fB-u\fR, \fB--user\fR
|
|
Set a secret for your user
|
|
|
|
.TP
|
|
\fB-v\fR, \fB--visibility\fR \fB<string> (default "private")\fR
|
|
Set visibility for an organization secret: {all|private|selected}
|
|
|
|
|
|
.SH OPTIONS INHERITED FROM PARENT COMMANDS
|
|
.TP
|
|
\fB-R\fR, \fB--repo\fR \fB<[HOST/]OWNER/REPO>\fR
|
|
Select another repository using the [HOST/]OWNER/REPO format
|
|
|
|
|
|
.SH EXIT CODES
|
|
0: Successful execution
|
|
|
|
.PP
|
|
1: Error
|
|
|
|
.PP
|
|
2: Command canceled
|
|
|
|
.PP
|
|
4: Authentication required
|
|
|
|
.PP
|
|
NOTE: Specific commands may have additional exit codes. Refer to the command's help for more information.
|
|
|
|
|
|
.SH EXAMPLE
|
|
.EX
|
|
# Paste secret value for the current repository in an interactive prompt
|
|
$ gh secret set MYSECRET
|
|
|
|
# Read secret value from an environment variable
|
|
$ gh secret set MYSECRET --body "$ENV_VALUE"
|
|
|
|
# Read secret value from a file
|
|
$ gh secret set MYSECRET < myfile.txt
|
|
|
|
# Set secret for a deployment environment in the current repository
|
|
$ gh secret set MYSECRET --env myenvironment
|
|
|
|
# Set organization-level secret visible to both public and private repositories
|
|
$ gh secret set MYSECRET --org myOrg --visibility all
|
|
|
|
# Set organization-level secret visible to specific repositories
|
|
$ gh secret set MYSECRET --org myOrg --repos repo1,repo2,repo3
|
|
|
|
# Set user-level secret for Codespaces
|
|
$ gh secret set MYSECRET --user
|
|
|
|
# Set repository-level secret for Dependabot
|
|
$ gh secret set MYSECRET --app dependabot
|
|
|
|
# Set multiple secrets imported from the ".env" file
|
|
$ gh secret set -f .env
|
|
|
|
# Set multiple secrets from stdin
|
|
$ gh secret set -f - < myfile.txt
|
|
|
|
.EE
|
|
|
|
|
|
.SH SEE ALSO
|
|
\fBgh-secret(1)\fR
|