abhilash1in / aws-secrets-manager-action

Use secrets from AWS Secrets Manager as environment variables in your GitHub Actions workflow
MIT License
68 stars 43 forks source link

Remove leading underscores from README #17

Closed hommel closed 3 years ago

hommel commented 3 years ago

The README incorrectly adds leading underscores to two examples used to demonstrate the conversion of secret names to POSIX compliant versions, which could lead to confusion about how to construct the environment variables to reference those secrets.

Also, removes trailing whitespace.

abhilash1in commented 3 years ago

@hommel the POSIX compliant version should not begin with a digit. So, the README is in accordance with that.

The correct thing for this action to do is transform 1/dev/foo into _1_DEV_FOO. Related test - here.

Please let me know if you're seeing a different behaviour.

hommel commented 3 years ago

Oh, I see. It's the digit that triggers the preceding underscore. I guess I glossed over this example, which covers my use case:

If your secret name is dev/foo, value is { "bar": "baz" } and parse-json is set to true, the injected environment variable name will be DEV_FOO_BAR (and value will be baz).

Behaves as expected then. Thanks for the response :+1: