Merge pull request #630 from commitizen-tools/fix-cz-yaml-format

Generate .cz.yaml that comply yamllint

Author: woile

.github/workflows/bumpversion.yml

@@ -12,7 +12,7 @@ jobs:
     name: "Bump version and create changelog with commitizen"
     steps:
       - name: Check out
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
           fetch-depth: 0
           token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'

.github/workflows/docspublish.yaml

@@ -9,12 +9,12 @@ jobs:
   publish-documentation:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'
         fetch-depth: 0
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies

.github/workflows/homebrewpublish.yaml

@@ -12,9 +12,9 @@ jobs:
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies

.github/workflows/pythonpackage.yml

@@ -10,11 +10,11 @@ jobs:
         platform: [ubuntu-20.04, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/pythonpublish.yaml

@@ -9,12 +9,12 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
       with:
         token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}'
         fetch-depth: 0
     - name: Set up Python
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v4
       with:
         python-version: '3.x'
     - name: Install dependencies

.pre-commit-config.yaml

@@ -35,5 +35,6 @@ repos:
         name: linter and test
         language: system
         pass_filenames: false
+        stage: push
         entry: ./scripts/test
         types: [python]

commitizen/config/yaml_config.py

@@ -17,7 +17,7 @@ def __init__(self, *, data: Union[bytes, str], path: Union[Path, str]):
 
     def init_empty_config_content(self):
         with smart_open(self.path, "a") as json_file:
-            yaml.dump({"commitizen": {}}, json_file)
+            yaml.dump({"commitizen": {}}, json_file, explicit_start=True)
 
     def _parse_setting(self, data: Union[bytes, str]) -> None:
         """We expect to have a section in cz.yaml looking like
@@ -44,6 +44,6 @@ def set_key(self, key, value):
 
         parser["commitizen"][key] = value
         with smart_open(self.path, "w") as yaml_file:
-            yaml.dump(parser, yaml_file)
+            yaml.dump(parser, yaml_file, explicit_start=True)
 
         return self

scripts/test

@@ -10,4 +10,4 @@ ${PREFIX}isort --check-only commitizen tests
 ${PREFIX}flake8 commitizen/ tests/
 ${PREFIX}mypy commitizen/ tests/
 ${PREFIX}pydocstyle --convention=google --add-ignore=D1,D415 --match-dir='"${REGEX}"'
-${PREFIX}commitizen check --rev-range origin/master..
+${PREFIX}commitizen -nr 3 check --rev-range origin/master..

tests/test_conf.py

@@ -160,3 +160,13 @@ def test_init_empty_config_content(self, tmpdir):
 
         with open(path, "r") as json_file:
             assert json.load(json_file) == {"commitizen": {}}
+
+
+class TestYamlConfig:
+    def test_init_empty_config_content(self, tmpdir):
+        path = tmpdir.mkdir("commitizen").join(".cz.yaml")
+        yaml_config = config.YAMLConfig(data="{}", path=path)
+        yaml_config.init_empty_config_content()
+
+        with open(path, "r") as yaml_file:
+            assert yaml.safe_load(yaml_file) == {"commitizen": {}}