Merge branch 'main' into leander-dsouza/fix-svn-test

Author: leander-dsouza

.github/dependabot.yml

@@ -1,3 +1,4 @@
+---
 version: 2
 updates:
   - package-ecosystem: "github-actions"

.github/workflows/ci.yml

@@ -1,3 +1,4 @@
+---
 name: vcs2l
 
 on:
@@ -13,39 +14,48 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [macos-latest, ubuntu-22.04, ubuntu-24.04, windows-2022, windows-2025]
+        os:
+          - macos-latest
+          - ubuntu-22.04
+          - ubuntu-24.04
+          - windows-2022
+          - windows-2025
         python-version: ["3.10", "3.12"]
+        include:
+          - os: ubuntu-22.04
+            python-version: "3.7"
+          - os: ubuntu-22.04
+            python-version: "3.8"
 
     steps:
-
-    - name: Checkout repository
-      uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
-
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
-      with:
-        python-version: ${{ matrix.python-version }}
-
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip setuptools wheel
-        python -m pip install --upgrade PyYAML
-
-    - name: Install dependencies (macOS)
-      run: |
-        brew install subversion mercurial
-      if: matrix.os == 'macos-latest'
-
-    - name: Install dependencies (Ubuntu)
-      run: |
-        sudo apt-get update
-        sudo apt-get install -y subversion mercurial
-      if: startsWith(matrix.os, 'ubuntu')
-
-    - name: Test with pytest
-      run: |
-        pip install --upgrade .[test]
-        pip install --upgrade coverage
-        git config --global --add init.defaultBranch main
-        git config --global --add advice.detachedHead true
-        ${{ startsWith(matrix.os, 'windows') && 'set PYTHONPATH=%cd% &&' || 'PYTHONPATH=`pwd`' }} pytest -s -v test
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install --upgrade PyYAML
+
+      - name: Install dependencies (macOS)
+        run: |
+          brew install subversion mercurial
+        if: matrix.os == 'macos-latest'
+
+      - name: Install dependencies (Ubuntu)
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y subversion mercurial
+        if: startsWith(matrix.os, 'ubuntu')
+
+      - name: Test with pytest
+        run: |
+          pip install --upgrade .[test]
+          pip install --upgrade coverage
+          git config --global --add init.defaultBranch main
+          git config --global --add advice.detachedHead true
+          ${{ startsWith(matrix.os, 'windows') && 'set PYTHONPATH=%cd% &&' || 'PYTHONPATH=`pwd`' }} pytest -s -v test

.github/workflows/lint.yml

@@ -1,3 +1,4 @@
+---
 name: Linting
 
 on:

.pre-commit-config.yaml

@@ -1,19 +1,27 @@
+---
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
+  - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
+      - id: check-yaml
 
--   repo: https://github.com/codespell-project/codespell
+  - repo: https://github.com/codespell-project/codespell
     rev: v2.4.1
     hooks:
-    -   id: codespell
+      - id: codespell
 
--   repo: https://github.com/astral-sh/ruff-pre-commit
+  - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: v0.12.9
     hooks:
       - id: ruff-check
-        args: [ --fix ]
+        args: [--fix]
       - id: ruff-format
+
+  - repo: https://github.com/adrienverge/yamllint.git
+    rev: v1.37.1
+    hooks:
+      - id: yamllint
+        args: [--strict, -c=.yamllint.yaml]

.yamllint.yaml

@@ -0,0 +1,7 @@
+---
+extends: default
+
+rules:
+  truthy: disable  # Prevent false positives on 'on:' in GitHub workflows
+  comments: disable  # Allow GitHub comment hashes to be separated by a single space for Dependabot compatibility.
+  line-length: disable  # Allow long lines in GitHub workflows due to GitHub hashes.

README.rst

@@ -88,7 +88,8 @@ Furthermore if the local branch has evolved from the remote repository an import
 To make sure to store the exact revision in the exported data use the command line argument ``--exact``.
 Since a specific revision is not tied to neither a branch nor a remote (for Git and Mercurial) the tool will check if the current hash exists in any of the remotes.
 If it exists in multiple the remotes ``origin`` and ``upstream`` are considered before any other in alphabetical order.
-
+For compatibility with `yamllint <https://yamllint.readthedocs.io/en/stable/>`_ the output can be formatted by passing the command line argument ``--lint``.
+This would add the document start and end markers (``---`` and ``...``) to the output.
 
 Import set of repositories
 ~~~~~~~~~~~~~~~~~~~~~~~~~~

publish-python.yaml

@@ -1,3 +1,4 @@
+---
 artifacts:
   - type: wheel
     uploads:

vcs2l/commands/export.py

@@ -42,6 +42,13 @@ def get_parser():
         default=False,
         help='Export unique tag names or commit hashes instead of branch names',
     )
+    group.add_argument(
+        '--lint',
+        action='store_true',
+        default=False,
+        help='Format output for compatibility with yamllint',
+    )
+
     return parser
 
 
@@ -123,9 +130,13 @@ def main(args=None, stdout=None, stderr=None):
             else:
                 result['path'] = os.path.join(basename, result['path'])
 
+    if args.lint:
+        print('---')
     print('repositories:')
     output_results(results, output_handler=output_export_data)
     output_results(results, output_handler=output_error_information)
+    if args.lint:
+        print('...')
 
     any_error = any(r['returncode'] for r in results)
     return 1 if any_error else 0