gigalixir/Gigalixir Deploy

Deploy your application to Gigalixir

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Activelast commit Mar 31, 2026
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: gigalixir/gigalixir-action@7c4c09ec2c3562eded85b711fd735eb34f8001e9 # v0.6.1

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
gigalixir_emailYour Gigalixir account emailno""
gigalixir_api_keyYour Gigalixir API keyno""
app_nameThe name of your Gigalixir appno""
actionAction to perform: deploy, create, destroy, create_deploy, or scalenodeploy
git_refThe git ref to deploy (commit SHA, branch, or tag)no""
cloudCloud provider for new apps (gcp or aws)no""
regionRegion for new apps (e.g., us-east-1, us-central1)no""
stackStack for new apps (e.g., gigalixir-20)no""
database_sizeDatabase size to create (free, 0.6, 1.7, 4, 8, 16, 32, 48, 64, 96). Use "free" for free tier.no""
database_versionPostgreSQL major version (e.g., 16, 15, 14)no""
copy_config_fromApp name to copy environment config from (useful for preview environments)no""
github_deploymentsCreate GitHub Deployment records for tracking. Requires repo write access. Not available for private repos on GitHub Free plan.nofalse
github_environmentGitHub Environment name for deployment tracking (e.g., production, staging, pr-123). Only used when github_deployments is true.no""
app_subfolderSubfolder containing the app to deploy (for monorepo/subtree deployments). When set, uses git subtree push instead of git push.no""
clean_build_cacheClear the build cache on Gigalixir before building. Useful when builds are broken due to stale cache.nofalse
deploy_timeoutMax seconds to wait for deployment rollout to complete. Set to 0 to skip verification.no0
replicasNumber of replicas to run (used with action: create, create_deploy, or scale)no""
sizeSize of each replica between 0.5 and 128 (used with action: create, create_deploy, or scale)no""
GIGALIXIR_USERNAMEDeprecated: use gigalixir_email insteadno""
GIGALIXIR_PASSWORDDeprecated: use gigalixir_api_key insteadno""
GIGALIXIR_APPDeprecated: use app_name insteadno""
GIGALIXIR_CLEANDeprecated: use clean_build_cache insteadno""
MIGRATIONSNot supported in v1. Use @v0 for SSH-based migration support.no""
SSH_PRIVATE_KEYNot supported in v1. Use @v0 for SSH-based migration support.no""
configsConfig variables to set before deploy, as multiline KEY=VALUE pairsno""
namedescription
deploy_statusStatus of the action (success or failure)
app_nameThe name of the Gigalixir app
app_urlThe URL of the deployed app
database_urlThe DATABASE_URL if a database was created