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

Document best practices when writing a script #167

Open
rvansa opened this issue Nov 18, 2022 · 1 comment
Open

Document best practices when writing a script #167

rvansa opened this issue Nov 18, 2022 · 1 comment
Assignees

Comments

@rvansa
Copy link
Member

rvansa commented Nov 18, 2022

  • general comment
  • list of accepted parameters as comment after the name of the script
  • if the script repeats variable with default, isolate this into initial - set-state: FOO ${{FOO:bar}}
  • ... ?
@rvansa
Copy link
Member Author

rvansa commented Nov 18, 2022

Also mention that passwords should not be in the scripts in plaintext, but loaded from file that could be encrypted via git crypt (or passed via the state):

  • how to pass a string from file as cmdline parameter
  • how to pass a string from file to command that expects the password as an interactive input

Maybe ^ shouldn't be in the same page, but should be linked.

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

No branches or pull requests

2 participants