From cfb9c8c4653215daa74cb6737cc73669b513d857 Mon Sep 17 00:00:00 2001 From: Seth Hoenig Date: Mon, 30 Nov 2020 09:46:40 -0600 Subject: [PATCH] docs: note manual jobspec parsing generally no longer required --- contributing/checklist-jobspec.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/contributing/checklist-jobspec.md b/contributing/checklist-jobspec.md index 5d6215124..315b00f43 100644 --- a/contributing/checklist-jobspec.md +++ b/contributing/checklist-jobspec.md @@ -4,9 +4,6 @@ * [ ] Consider similar features in Consul, Kubernetes, and other tools. Is there prior art we should match? Terminology, structure, etc? -* [ ] Parse in `jobspec/parse.go` -* [ ] Test in `jobspec/parse_test.go` (preferably with a - `jobspec/text-fixtures/.hcl` test file) * [ ] Add structs/fields to `api/` package * structs usually have Canonicalize, Copy, and Merge methods * New fields should be added to existing Canonicalize, Copy, and Merge @@ -21,6 +18,16 @@ * Note that fields must be listed in alphabetical order in `FieldDiff` slices in `nomad/structs/diff_test.go` * [ ] Test conversion +## HCL1 (deprecated) + +New jobspec entries should only be added to `jobspec2`. It makes use of HCL2 +and the `api` package for automatic parsing. Before, additional parsing was +required in the original `jobspec` package. + +* [ ] ~~Parse in `jobspec/parse.go`~~ (HCL1 only) +* [ ] ~~Test in `jobspec/parse_test.go` (preferably with a + `jobspec/text-fixtures/.hcl` test file)~~ (HCL1 only) + ## Docs * [ ] Changelog