diff --git a/.env.example b/.env.example index 2db35299..ddd011c9 100644 --- a/.env.example +++ b/.env.example @@ -1,21 +1,49 @@ # DO NOT DEFINE PRODUCTION SECRETS IN THIS FILE NOR IN ANY OTHER COMMITTED FILES. # -# Create .env file using this file as a template. +# Create a .env file using this file as a template. # Define all your variables for local development as described below. -# +# # - Use environment variables with prefix "AWS_" to give access to your test AWS account. # - Use environment variables with prefix "INPUT_" to simulate GitHub Actions input. -# - Use GITHUB_REPOSITORY environment variable to provide the GitHub repository and it's owher as a context in the script. Use formst "owner/repo". +# Each maps to an action.yml input: INPUT_, upper-cased. +# - Use the GITHUB_REPOSITORY environment variable to provide the GitHub repository +# and its owner as context for the script. Use the format "owner/repo". +# --- AWS credentials (test account) --- AWS_ACCESS_KEY_ID= AWS_SECRET_ACCESS_KEY= AWS_REGION= + +# --- GitHub context --- +GITHUB_REPOSITORY= + +# --- Action inputs (mirror of action.yml) --- + +# Required in every mode. INPUT_MODE= INPUT_GITHUB-TOKEN= -INPUT_EC2-IMAGE-ID= + +# Required for 'start' mode. INPUT_EC2-INSTANCE-TYPE= INPUT_SUBNET-ID= INPUT_SECURITY-GROUP-ID= +# Provide an explicit AMI id... +INPUT_EC2-IMAGE-ID= +# ...or a stringified JSON array of filters to look one up, optionally scoped by owner. +INPUT_EC2-IMAGE-FILTERS= +INPUT_EC2-IMAGE-OWNER= + +# Required for 'stop' mode. INPUT_LABEL= INPUT_EC2-INSTANCE-ID= -GITHUB_REPOSITORY= + +# Optional. +INPUT_EIP-ALLOCATION-ID= +INPUT_IAM-ROLE-NAME= +INPUT_RUNNER-VERSION= +INPUT_ENCRYPT-EBS= +INPUT_HTTP-TOKENS= +INPUT_DEBUG= +# Stringified JSON array of AWS Tag objects. Must be valid JSON when set +# (config.js parses it unconditionally); use [] for "no tags" locally. +INPUT_AWS-RESOURCE-TAGS=[] diff --git a/.gitignore b/.gitignore index 1dcef2d9..37d7e734 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,2 @@ node_modules -.env \ No newline at end of file +.env