Skip to content

🔐Github Action. create `.env` via AWS SSM parameters path

License

Notifications You must be signed in to change notification settings

nilsdebruin/action-aws-ssm-to-dotenv

 
 

Repository files navigation

action aws ssm to dotenv

create .env or shell script via AWS SSM parameters path

usage

- uses: deptno/[email protected]
  env:
    AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} # required
    AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} # required
    AWS_DEFAULT_REGION: ap-northeast-2 # required
  with:
    ssm-path: /opensource/action-aws-ssm-to-dotenv # required
    format: shell
    output: .env.development
    set-as-env: false
    set-case: upper
    prefix-paths: true
    prefix: SSM_
    decryption: true

⚠️ if output file already exists action_aws_ssm_to_dotenv will append data to output file(1.3.0)

option

ssm-path(required)

AWS Systems Manager > Parameter Store > Path

format(default dotenv)

optional, default=dotenv

  • dotenv: KEY="value" (default)
  • shell: export KEY="value"
  • yaml: KEY: "value"
  • json: {"KEY": "value"}
  • plain: value

output(default .env)

output filename

prefix(optional)

add prefix to exported variable name
eg) prefix: ACTION_ will export ACTION_ENV_VAR="value"

set-as-env(default true)

Sets the values as environment variables for this GitHub Actions Job

set-case (optional)

Transform the keys to upper, lower, or none for unchanged

prefix-paths (optional)

If true the relative path from the ssm-paths value to the parameter is prefixed on the key. So if the key full path is /envs/dev/mysql_user then if this is true and ssm-paths value was
"/env/" the key presented would be "dev_mysql_user"'

decryption(optional)

should parameters be decrypted?

.github/workflows/test.yml

cabinet


License

MIT

About

🔐Github Action. create `.env` via AWS SSM parameters path

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 55.4%
  • TypeScript 44.6%