AthenZ / k8s-athenz-sia

Apache License 2.0

1 stars 7 forks source link

fix athenz-sia.env #43

Closed t4niwa closed 10 months ago

t4niwa commented 10 months ago

Description

Specify default value for binary
Provide the URL where the default value is set
Adjust the order of environment variables to match config.go

Type of change

[ ] Bug fix
[ ] New feature
[ ] Refactoring (no functional changes, no api changes)
[x] Non-code changes (update documentation, pipeline, etc.)

Flags

[ ] Breaks backward compatibility
[ ] Requires a documentation update
[ ] Has untestable code

Related issue/PR

Delete this section if there are no issues or pull requests that relate to this pull request.

Fixes #issue
Closes #PR

Checklist

[ ] Followed the guidelines in the CONTRIBUTING document
[ ] Added prefix [skip ci]/[ci skip]/[no ci]/[skip actions]/[actions skip] in the PR title if necessary
[ ] Tested and linted the code
[ ] Commented the code
[ ] Made corresponding changes to the documentation
[ ] Passed all pipeline checking

Checklist for maintainer

Use Squash and merge
Double-confirm the merge message has prefix [skip ci]/[ci skip]/[no ci]/[skip actions]/[actions skip]
Delete the branch after merge

mlajkim commented 10 months ago

@t4niwa I think you can put the rules that you've describe on the description of this pr for the .env

# Guidelines for managing the env file here:
#   1. If a default value is present, it must be provided with the URL where the default value is set
#   1. Follow the order of env variables as listed on https://github.com/AthenZ/k8s-athenz-sia/blob/main/pkg/config/config.go

OR you may put it on README.md, whichever way that you think its great to follow and not forget.

t4niwa commented 10 months ago

@mlajkim added in https://github.com/AthenZ/k8s-athenz-sia/pull/43/commits/e818143cfd58c52369021ef54d1614a4695419bc