From 329ea5a77ea57d1a1b9aa61a295f3b4ddfc014ce Mon Sep 17 00:00:00 2001 From: Seth Hoenig Date: Wed, 25 Mar 2020 09:33:27 -0600 Subject: [PATCH] doc: add a reminder about field order for diff comparisons After spending hours re-learning this lesson more than once, update the jobspec contribution guide with a reminder about how to configure FieldDiff comparisons. --- contributing/checklist-jobspec.md | 1 + 1 file changed, 1 insertion(+) diff --git a/contributing/checklist-jobspec.md b/contributing/checklist-jobspec.md index acc198787..83db385f8 100644 --- a/contributing/checklist-jobspec.md +++ b/contributing/checklist-jobspec.md @@ -17,6 +17,7 @@ * Implement other methods and tests from `api/` package * [ ] Add conversion between `api/` and `nomad/structs` in `command/agent/job_endpoint.go` * [ ] Add check for job diff in `nomad/structs/diff.go` + * Note that fields must be listed in alphabetical order in `FieldDiff` slices in `nomad/structs/diff_test.go` * [ ] Test conversion ## Docs