Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README non-explicit on wether _SECRET_ is optional. #16

Closed
jhunterkohler opened this issue Apr 15, 2021 · 1 comment · Fixed by #17
Closed

README non-explicit on wether _SECRET_ is optional. #16

jhunterkohler opened this issue Apr 15, 2021 · 1 comment · Fixed by #17

Comments

@jhunterkohler
Copy link

The README is non-explicit on wether SECRET is optional in a variable name.
This seems like a tiny oversight in documentation. I'm not sure how to fix it, because I don't really know wether it is optional, or the implications of not putting _SECRET_.

@AngelOnFira
Copy link
Member

Are you referring to this line of the documentation?

envkey_SECRET_KEY: ${{ secrets.SECRET_KEY }}

I suppose the documentation might be a bit ambiguous, as the name of the variable only matters for what you'll expect to see in your envfile. The envkey_ prefix is only there for the Action to be able to discover the variables you want to add to the file. I suppose it might we worth adding what that example Action would output.

To be clear for now, the Action in the docs will output a file called .env that contains:

DEBUG: false
SOME_API_KEY: "123456abcdef"
SECRET_KEY: "the_secret_from_the_repository_secrets"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants