luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

contrib: Update contributing checklist for config

This commit is contained in:
Daniel Nephin 2020-12-21 17:05:56 -05:00
parent fc88c28bb9
commit 119a6b3642
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
contributing/checklist-adding-config-fields.md
View File

@ -29,10 +29,10 @@ There are four specific cases covered with increasing complexity:
`agent/config/runtime.go`. `agent/config/runtime.go`.
- [ ] Add an appropriate parser/setter in `agent/config/builder.go` to - [ ] Add an appropriate parser/setter in `agent/config/builder.go` to
translate. translate.
- [ ] Add the new field with a random value to both the JSON and HCL blobs in - [ ] Add the new field with a random value to both the JSON and HCL files in
`TestFullConfig` in `agent/config/runtime_test.go`, it should fail now, then `agent/config/testdata/full-config.*`, which should cause the test to fail.
add the same random value to the expected struct in that test so it passes Then update the expected value in `TestLoad_FullConfig` in
again. `agent/config/runtime_test.go` to make the test pass again.
- [ ] Run `go test -run TestRuntimeConfig_Sanitize ./agent/config -update` to update - [ ] Run `go test -run TestRuntimeConfig_Sanitize ./agent/config -update` to update
the expected value for `TestRuntimeConfig_Sanitize`. Look at `git diff` to the expected value for `TestRuntimeConfig_Sanitize`. Look at `git diff` to
make sure the value changed as you expect. make sure the value changed as you expect.