published on Wednesday, Apr 29, 2026 by Pulumi
published on Wednesday, Apr 29, 2026 by Pulumi
This resource allows you to create and manage GitHub Actions secrets within your GitHub repositories. You must have write access to a repository to use this resource.
Secret values are encrypted using the Go ‘/crypto/box’ module which is interoperable with libsodium. Libsodium is used by GitHub to decrypt secret values.
For the purposes of security, the contents of the value field have been marked as sensitive to Terraform,
but it is important to note that this does not hide it from state files. You should treat state as sensitive always.
It is also advised that you do not store plaintext values in your code but rather populate the valueEncrypted
using fields from a resource, data source or variable as, while encrypted in state, these will be easily accessible
in your code. See below for an example of this abstraction.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const examplePlaintext = new github.ActionsSecret("example_plaintext", {
repository: "example_repository",
secretName: "example_secret_name",
value: someSecretString,
});
const exampleEncrypted = new github.ActionsSecret("example_encrypted", {
repository: "example_repository",
secretName: "example_secret_name",
valueEncrypted: someEncryptedSecretString,
});
import pulumi
import pulumi_github as github
example_plaintext = github.ActionsSecret("example_plaintext",
repository="example_repository",
secret_name="example_secret_name",
value=some_secret_string)
example_encrypted = github.ActionsSecret("example_encrypted",
repository="example_repository",
secret_name="example_secret_name",
value_encrypted=some_encrypted_secret_string)
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := github.NewActionsSecret(ctx, "example_plaintext", &github.ActionsSecretArgs{
Repository: pulumi.String("example_repository"),
SecretName: pulumi.String("example_secret_name"),
Value: pulumi.Any(someSecretString),
})
if err != nil {
return err
}
_, err = github.NewActionsSecret(ctx, "example_encrypted", &github.ActionsSecretArgs{
Repository: pulumi.String("example_repository"),
SecretName: pulumi.String("example_secret_name"),
ValueEncrypted: pulumi.Any(someEncryptedSecretString),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var examplePlaintext = new Github.Index.ActionsSecret("example_plaintext", new()
{
Repository = "example_repository",
SecretName = "example_secret_name",
Value = someSecretString,
});
var exampleEncrypted = new Github.Index.ActionsSecret("example_encrypted", new()
{
Repository = "example_repository",
SecretName = "example_secret_name",
ValueEncrypted = someEncryptedSecretString,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.ActionsSecret;
import com.pulumi.github.ActionsSecretArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var examplePlaintext = new ActionsSecret("examplePlaintext", ActionsSecretArgs.builder()
.repository("example_repository")
.secretName("example_secret_name")
.value(someSecretString)
.build());
var exampleEncrypted = new ActionsSecret("exampleEncrypted", ActionsSecretArgs.builder()
.repository("example_repository")
.secretName("example_secret_name")
.valueEncrypted(someEncryptedSecretString)
.build());
}
}
resources:
examplePlaintext:
type: github:ActionsSecret
name: example_plaintext
properties:
repository: example_repository
secretName: example_secret_name
value: ${someSecretString}
exampleEncrypted:
type: github:ActionsSecret
name: example_encrypted
properties:
repository: example_repository
secretName: example_secret_name
valueEncrypted: ${someEncryptedSecretString}
Example Lifecycle Ignore Changes
This resource supports using the lifecycle ignoreChanges block on remoteUpdatedAt to support use cases where a secret value is created using a placeholder value and then modified after creation outside the scope of Terraform. This approach ensures only the initial placeholder value is referenced in your code and in the resulting state file.
import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";
const exampleAllowDrift = new github.ActionsSecret("example_allow_drift", {
repository: "example_repository",
secretName: "example_secret_name",
value: "placeholder",
});
import pulumi
import pulumi_github as github
example_allow_drift = github.ActionsSecret("example_allow_drift",
repository="example_repository",
secret_name="example_secret_name",
value="placeholder")
package main
import (
"github.com/pulumi/pulumi-github/sdk/v6/go/github"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := github.NewActionsSecret(ctx, "example_allow_drift", &github.ActionsSecretArgs{
Repository: pulumi.String("example_repository"),
SecretName: pulumi.String("example_secret_name"),
Value: pulumi.String("placeholder"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;
return await Deployment.RunAsync(() =>
{
var exampleAllowDrift = new Github.Index.ActionsSecret("example_allow_drift", new()
{
Repository = "example_repository",
SecretName = "example_secret_name",
Value = "placeholder",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.ActionsSecret;
import com.pulumi.github.ActionsSecretArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var exampleAllowDrift = new ActionsSecret("exampleAllowDrift", ActionsSecretArgs.builder()
.repository("example_repository")
.secretName("example_secret_name")
.value("placeholder")
.build());
}
}
resources:
exampleAllowDrift:
type: github:ActionsSecret
name: example_allow_drift
properties:
repository: example_repository
secretName: example_secret_name
value: placeholder
Create ActionsSecret Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ActionsSecret(name: string, args: ActionsSecretArgs, opts?: CustomResourceOptions);@overload
def ActionsSecret(resource_name: str,
args: ActionsSecretArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ActionsSecret(resource_name: str,
opts: Optional[ResourceOptions] = None,
repository: Optional[str] = None,
secret_name: Optional[str] = None,
destroy_on_drift: Optional[bool] = None,
encrypted_value: Optional[str] = None,
key_id: Optional[str] = None,
plaintext_value: Optional[str] = None,
value: Optional[str] = None,
value_encrypted: Optional[str] = None)func NewActionsSecret(ctx *Context, name string, args ActionsSecretArgs, opts ...ResourceOption) (*ActionsSecret, error)public ActionsSecret(string name, ActionsSecretArgs args, CustomResourceOptions? opts = null)
public ActionsSecret(String name, ActionsSecretArgs args)
public ActionsSecret(String name, ActionsSecretArgs args, CustomResourceOptions options)
type: github:ActionsSecret
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args ActionsSecretArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ActionsSecretArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ActionsSecretArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ActionsSecretArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ActionsSecretArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var actionsSecretResource = new Github.ActionsSecret("actionsSecretResource", new()
{
Repository = "string",
SecretName = "string",
KeyId = "string",
Value = "string",
ValueEncrypted = "string",
});
example, err := github.NewActionsSecret(ctx, "actionsSecretResource", &github.ActionsSecretArgs{
Repository: pulumi.String("string"),
SecretName: pulumi.String("string"),
KeyId: pulumi.String("string"),
Value: pulumi.String("string"),
ValueEncrypted: pulumi.String("string"),
})
var actionsSecretResource = new ActionsSecret("actionsSecretResource", ActionsSecretArgs.builder()
.repository("string")
.secretName("string")
.keyId("string")
.value("string")
.valueEncrypted("string")
.build());
actions_secret_resource = github.ActionsSecret("actionsSecretResource",
repository="string",
secret_name="string",
key_id="string",
value="string",
value_encrypted="string")
const actionsSecretResource = new github.ActionsSecret("actionsSecretResource", {
repository: "string",
secretName: "string",
keyId: "string",
value: "string",
valueEncrypted: "string",
});
type: github:ActionsSecret
properties:
keyId: string
repository: string
secretName: string
value: string
valueEncrypted: string
ActionsSecret Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ActionsSecret resource accepts the following input properties:
- Repository string
- Name of the repository.
- Secret
Name string - Name of the secret.
- Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- Encrypted
Value string - (Optional) Please use
valueEncrypted. - Key
Id string - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - Plaintext
Value string - (Optional) Please use
value. - Value string
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - Value
Encrypted string - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- Repository string
- Name of the repository.
- Secret
Name string - Name of the secret.
- Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- Encrypted
Value string - (Optional) Please use
valueEncrypted. - Key
Id string - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - Plaintext
Value string - (Optional) Please use
value. - Value string
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - Value
Encrypted string - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- repository String
- Name of the repository.
- secret
Name String - Name of the secret.
- destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted
Value String - (Optional) Please use
valueEncrypted. - key
Id String - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext
Value String - (Optional) Please use
value. - value String
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value
Encrypted String - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- repository string
- Name of the repository.
- secret
Name string - Name of the secret.
- destroy
On booleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted
Value string - (Optional) Please use
valueEncrypted. - key
Id string - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext
Value string - (Optional) Please use
value. - value string
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value
Encrypted string - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- repository str
- Name of the repository.
- secret_
name str - Name of the secret.
- destroy_
on_ booldrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted_
value str - (Optional) Please use
valueEncrypted. - key_
id str - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext_
value str - (Optional) Please use
value. - value str
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value_
encrypted str - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- repository String
- Name of the repository.
- secret
Name String - Name of the secret.
- destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted
Value String - (Optional) Please use
valueEncrypted. - key
Id String - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext
Value String - (Optional) Please use
value. - value String
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value
Encrypted String - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
Outputs
All input properties are implicitly available as output properties. Additionally, the ActionsSecret resource produces the following output properties:
- Created
At string - Date the secret was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Repository
Id int - ID of the repository.
- Updated
At string - Date the secret was last updated by the provider.
- Created
At string - Date the secret was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Repository
Id int - ID of the repository.
- Updated
At string - Date the secret was last updated by the provider.
- created
At String - Date the secret was created.
- id String
- The provider-assigned unique ID for this managed resource.
- remote
Updated StringAt - Date the secret was last updated in GitHub.
- repository
Id Integer - ID of the repository.
- updated
At String - Date the secret was last updated by the provider.
- created
At string - Date the secret was created.
- id string
- The provider-assigned unique ID for this managed resource.
- remote
Updated stringAt - Date the secret was last updated in GitHub.
- repository
Id number - ID of the repository.
- updated
At string - Date the secret was last updated by the provider.
- created_
at str - Date the secret was created.
- id str
- The provider-assigned unique ID for this managed resource.
- remote_
updated_ strat - Date the secret was last updated in GitHub.
- repository_
id int - ID of the repository.
- updated_
at str - Date the secret was last updated by the provider.
- created
At String - Date the secret was created.
- id String
- The provider-assigned unique ID for this managed resource.
- remote
Updated StringAt - Date the secret was last updated in GitHub.
- repository
Id Number - ID of the repository.
- updated
At String - Date the secret was last updated by the provider.
Look up Existing ActionsSecret Resource
Get an existing ActionsSecret resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: ActionsSecretState, opts?: CustomResourceOptions): ActionsSecret@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
created_at: Optional[str] = None,
destroy_on_drift: Optional[bool] = None,
encrypted_value: Optional[str] = None,
key_id: Optional[str] = None,
plaintext_value: Optional[str] = None,
remote_updated_at: Optional[str] = None,
repository: Optional[str] = None,
repository_id: Optional[int] = None,
secret_name: Optional[str] = None,
updated_at: Optional[str] = None,
value: Optional[str] = None,
value_encrypted: Optional[str] = None) -> ActionsSecretfunc GetActionsSecret(ctx *Context, name string, id IDInput, state *ActionsSecretState, opts ...ResourceOption) (*ActionsSecret, error)public static ActionsSecret Get(string name, Input<string> id, ActionsSecretState? state, CustomResourceOptions? opts = null)public static ActionsSecret get(String name, Output<String> id, ActionsSecretState state, CustomResourceOptions options)resources: _: type: github:ActionsSecret get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Created
At string - Date the secret was created.
- Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- Encrypted
Value string - (Optional) Please use
valueEncrypted. - Key
Id string - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - Plaintext
Value string - (Optional) Please use
value. - Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Repository string
- Name of the repository.
- Repository
Id int - ID of the repository.
- Secret
Name string - Name of the secret.
- Updated
At string - Date the secret was last updated by the provider.
- Value string
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - Value
Encrypted string - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- Created
At string - Date the secret was created.
- Destroy
On boolDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- Encrypted
Value string - (Optional) Please use
valueEncrypted. - Key
Id string - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - Plaintext
Value string - (Optional) Please use
value. - Remote
Updated stringAt - Date the secret was last updated in GitHub.
- Repository string
- Name of the repository.
- Repository
Id int - ID of the repository.
- Secret
Name string - Name of the secret.
- Updated
At string - Date the secret was last updated by the provider.
- Value string
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - Value
Encrypted string - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- created
At String - Date the secret was created.
- destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted
Value String - (Optional) Please use
valueEncrypted. - key
Id String - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext
Value String - (Optional) Please use
value. - remote
Updated StringAt - Date the secret was last updated in GitHub.
- repository String
- Name of the repository.
- repository
Id Integer - ID of the repository.
- secret
Name String - Name of the secret.
- updated
At String - Date the secret was last updated by the provider.
- value String
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value
Encrypted String - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- created
At string - Date the secret was created.
- destroy
On booleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted
Value string - (Optional) Please use
valueEncrypted. - key
Id string - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext
Value string - (Optional) Please use
value. - remote
Updated stringAt - Date the secret was last updated in GitHub.
- repository string
- Name of the repository.
- repository
Id number - ID of the repository.
- secret
Name string - Name of the secret.
- updated
At string - Date the secret was last updated by the provider.
- value string
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value
Encrypted string - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- created_
at str - Date the secret was created.
- destroy_
on_ booldrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted_
value str - (Optional) Please use
valueEncrypted. - key_
id str - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext_
value str - (Optional) Please use
value. - remote_
updated_ strat - Date the secret was last updated in GitHub.
- repository str
- Name of the repository.
- repository_
id int - ID of the repository.
- secret_
name str - Name of the secret.
- updated_
at str - Date the secret was last updated by the provider.
- value str
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value_
encrypted str - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
- created
At String - Date the secret was created.
- destroy
On BooleanDrift (Optional) This is ignored as drift detection is built into the resource.
Note: One of either
encryptedValueorplaintextValuemust be specified.- encrypted
Value String - (Optional) Please use
valueEncrypted. - key
Id String - ID of the public key used to encrypt the secret, required when setting
encryptedValue. - plaintext
Value String - (Optional) Please use
value. - remote
Updated StringAt - Date the secret was last updated in GitHub.
- repository String
- Name of the repository.
- repository
Id Number - ID of the repository.
- secret
Name String - Name of the secret.
- updated
At String - Date the secret was last updated by the provider.
- value String
- Plaintext value of the secret to be encrypted. This conflicts with
valueEncrypted,encryptedValue&plaintextValue. - value
Encrypted String - Encrypted value of the secret using the GitHub public key in Base64 format,
keyIdis required with this value. This conflicts withvalue,encryptedValue&plaintextValue.
Import
This resource can be imported using an ID made of the repository name, and secret name separated by a :.
Note: When importing secrets, the
value,valueEncrypted,encryptedValue, orplaintextValuefields will not be populated in the state. You may need to ignore changes for these as a workaround if you’re not planning on updating the secret through Terraform.
Import Command
The following command imports a GitHub actions secret named mysecret for the repo myrepo to a github.ActionsSecret resource named example.
$ pulumi import github:index/actionsSecret:ActionsSecret example myrepo:mysecret
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- GitHub pulumi/pulumi-github
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
githubTerraform Provider.
published on Wednesday, Apr 29, 2026 by Pulumi
