online - yaml tutorial español

¿Cuál es el estilo de denominación canónica de YAML?

Question

Estoy diseñando un nuevo archivo YAML, y quiero usar el estilo de nomenclatura más estándar. Cual es

¿Con guión?

- job-name:
    ...

lower_case_with_underscores?

- job_name:
    ...

¿El caso de Carmel?

- jobName:
    ...

Answer 1

Añadiendo a las respuestas de @ :

Kubernetes utilizando CamelCase: https://kubernetes.io/docs/user-guide/jobs/

restartPolicy , restartPolicy

CircleCI usando snake_case: https://circleci.com/docs/1.0/configuration/

minitest_globs vcs_url , build_url

Jenkins con guión-caso: https://github.com/jenkinsci/yaml-project-plugin/blob/master/samples/google-cloud-storage/.jenkins.yaml

stapler-class

Entonces, no parece que haya un estándar definido, y los proyectos usan sus propias convenciones.

Answer 2

Utilice el estándar dictado por el software circundante.

Por ejemplo, en mi proyecto actual, el archivo YAML contiene valores predeterminados para los atributos de Python. Dado que los nombres utilizados en YAML aparecen en la API de Python asociada, está claro que en este proyecto en particular, los nombres de YAML deben obedecer a la convención de nomenclatura de python lower_case_with_underscores según PEP-8.

Mi próximo proyecto podría tener una convención de nomenclatura predominante diferente, en cuyo caso lo usaré en los archivos YAML asociados.