web-dev-qa-db-fra.com

Quel est le style de nommage canonique YAML

Je conçois un nouveau fichier YAML et je souhaite utiliser le style de dénomination le plus standard. Lequel est-ce?

Césure?

- job-name:
    ...

lower_case_with_underscores?

- job_name:
    ...

Affaire de chameau?

- jobName:
    ...
yaml
49
John McGehee

Utilisez la norme dictée par le logiciel environnant.

Par exemple, dans mon projet actuel, le fichier YAML contient des valeurs par défaut pour les attributs Python. Étant donné que les noms utilisés dans YAML apparaissent dans l’API Python API associée, il s’agit clair que sur ce projet particulier, les noms YAML doivent obéir au Python lower_case_with_underscores convention de dénomination selon PEP-8.

Mon prochain projet pourrait avoir une convention de dénomination dominante différente, auquel cas je l'utiliserai dans les fichiers YAML associés.

46
John McGehee

Ajout aux réponses de @ john :

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

apiVersion, restartPolicy

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

minitest_globsvcs_url, build_url

Jenkins avec étui: https://github.com/jenkinsci/yaml-project-plugin/blob/master/samples/google-cloud-storage/.jenkins.yaml

stapler-class

Il ne semble donc pas y avoir de norme définie et les projets utilisent leurs propres conventions.

27
Eyal Levin