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

Change job init default to example.nomad.hcl and recommend in docs #15997

Merged
merged 2 commits into from
Feb 2, 2023

Conversation

gulducat
Copy link
Member

Historically we have recommended the file extension .nomad for HCL job specification files. This results in downstream issues like ~"Please support '.nomad' files in the HCL VS Code extension" where one solution is to append .hcl to the filename.

This formalizes that recommendation by:

  • nomad job init now produces example.nomad.hcl by default:
$ nomad job init
Example job file written to example.nomad.hcl
  • references to that and similar filenames are updated in website docs

This does not

  • stop fmt from also formatting .nomad files
  • change all our tests and such that use various *.nomad files and "files"
  • update docs that reference files outside of this repo

Closes #13350

@gulducat gulducat requested a review from tgross January 31, 2023 22:37
Copy link
Member

@tgross tgross left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

We probably should follow up with a pass over the Tutorials repo as well.

instead of .nomad (without .hcl)

* nomad job init -> example.nomad.hcl
* update docs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change job spec name convention to *.nomad.hcl
2 participants