This GitHub Action enables you to import secrets from Infisical—whether hosted in the cloud or self-hosted—directly into your GitHub workflows.
- In order to use this, you will need to configure a Machine Identity for your project.
- This action supports three ways to authenticate your workflows with Infisical - AWS IAM Auth, OIDC and universal auth.
- Configure a machine identity to use the "AWS Auth" method. Set the allowed principal ARNs, account IDs, and other settings as needed for your setup. Refer to the setup guide here.
- Get the machine identity's ID.
- Set
method
to aws-iam and configure theidentity-id
input parameter. - Your GitHub Action runner must have access to AWS credentials (either through IAM roles, environment variables, or other AWS credential providers).
- Ensure your runner has network access to AWS STS API endpoints.
- uses: Infisical/secrets-action@v1.0.9
with:
method: "aws-iam"
identity-id: "24be0d94-b43a-41c4-812c-1e8654d9ce1e"
domain: "https://app.infisical.com" # Update to the instance URL when using EU (https://eu.infisical.com), a dedicated instance, or a self-hosted instance
env-slug: "dev"
project-slug: "cli-integration-tests-9-edj"
- Configure a machine identity to use the "OIDC Auth" method. Set the bound audience, bound subject, and bound claims as needed for your setup. Refer to the setup guide here.
- Get the machine identity's ID.
- Set
method
to oidc and configure theidentity-id
input parameter. Optionally, customize the JWT's aud field by setting theoidc-audience
input parameter. - For debugging OIDC configuration issues, you can use GitHub's actions-oidc-debugger tool. This tool helps you inspect the JWT claims and verify they match your configuration.
- Add
id-token: write
to the permissions for your workflow:
permissions:
id-token: write
contents: read
- Configure a machine identity to have an auth method of "Universal Auth".
- Get the machine identity's
client_id
andclient_secret
and store them as Github secrets (recommended) or environment variables. - Set the
client-id
andclient-secret
input parameters.
With this action, you can use your Infisical secrets in two ways: as environment variables or as a file.
Secrets are injected as environment variables and can be referenced by subsequent workflow steps.
- uses: Infisical/secrets-action@v1.0.9
with:
method: "oidc"
identity-id: "24be0d94-b43a-41c4-812c-1e8654d9ce1e"
domain: "https://app.infisical.com" # Update to the instance URL when using EU (https://eu.infisical.com), a dedicated instance, or a self-hosted instance
env-slug: "dev"
project-slug: "cli-integration-tests-9-edj"
Exports secrets to a file in your GITHUB_WORKSPACE
, useful for applications that read from .env
files.
- uses: Infisical/secrets-action@v1.0.9
with:
method: "oidc"
identity-id: "24be0d94-b43a-41c4-812c-1e8654d9ce1e"
domain: "https://app.infisical.com" # Update to the instance URL when using EU (https://eu.infisical.com), a dedicated instance, or a self-hosted instance
env-slug: "dev"
project-slug: "cli-integration-tests-9-edj"
export-type: "file"
file-output-path: "/src/.env" # defaults to "/.env"
Note: Make sure to configure an actions/checkout
step before using this action in file export mode
steps:
- name: Checkout code
uses: actions/checkout@v4
Optional. The authentication method to use. Defaults to universal
. Possible values are universal
, oidc
, and aws-iam
Optional. Machine Identity client ID
Optional. Machine Identity secret key
Optional. Machine Identity ID
Optional. Custom aud claim for the signed Github ID token
Required. Source project slug
Required. Source environment slug
Optional. Infisical URL. Defaults to https://app.infisical.com. If you're using Infisical EU (https://eu.infisical.com) or a self-hosted/dedicated instance, you will need to set the appropriate value for this field.
Optional. If set to env
, it will set the fetched secrets as environment variables for subsequent steps of a workflow. If set to file
, it will export the secrets in a .env file in the defined file-output-path. Defaults to env
Optional. The path to save the file when export-type is set to file
. Defaults to /.env
Optional. Source secret path. Defaults to /
. Example: /my-secret-path
.
Optional. If set to true
, it will include imported secrets. Defaults to true
Optional. If set to true
, it will fetch all secrets from the specified base path and all of its subdirectories. Defaults to false