gitlabform 6.2.0__tar.gz → 6.2.2__tar.gz

gitlabform-6.2.2/.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @amimas @gdubicki @rickbrouwer @TimKnight01

{gitlabform-6.2.0 → gitlabform-6.2.2}/.github/dependabot.yml

@@ -9,29 +9,48 @@ updates:
     directory: "/"
     schedule:
       interval: "weekly"
+
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "monthly"
+
   - package-ecosystem: "uv"
     directory: "/"
     schedule:
       interval: "weekly"
+    cooldown:
+      default-days: 30
+      include:
+        - "pytest*"
+        - "coverage"
+        - "cryptography"
+        - "deepdiff"
+        - "xkcdpass"
+        - "bandit"
+        - "black"
+        - "codespell"
+        - "mypy*"
+        - "ruff"
+        - "types-*"
+        - "markdown*"
+        - "zensical*"
+        - "pygments"
+        - "pymdown-extensions"
+        - "check-wheel-contents"
+        - "twine"
+        - "commitizen"
+        - "prek"
     groups:
-      # Group dependencies by their type (testing, linting, documentation, release tools)
-      # to avoid overwhelming PRs and to allow for more focused updates.
-      # The patterns are based on the names of the dependencies as they appear in the pyproject.toml file
-      # and how they are grouped in the uv configuration.
-      # Dependencies that match the patterns will be grouped together in the same PR.
-      testing:
+      # Keep the dev-only dependency update churn lower by checking it monthly,
+      # while still keeping the largest dev tool groups focused.
+      dev-tooling:
         patterns:
           - "pytest*"
           - "coverage"
           - "cryptography"
           - "deepdiff"
           - "xkcdpass"
-      linting:
-        patterns:
           - "bandit"
           - "black"
           - "codespell"
@@ -41,7 +60,7 @@ updates:
       documentation:
         patterns:
           - "markdown*"
-          - "mkdocs*"
+          - "zensical*"
           - "pygments"
           - "pymdown-extensions"
       release-tools:

{gitlabform-6.2.0 → gitlabform-6.2.2}/.github/workflows/_releases.yml

@@ -62,18 +62,7 @@ jobs:
           # Manual Trigger Inputs (from workflow_dispatch)
           MANUAL_RELEASE_TAG: ${{ inputs.manual_tag }}
           MANUAL_UPSTREAM_RUN_ID: ${{ inputs.override_run_id }}
-        run: uv run release gh-workflow-check
-
-  # TODO: Remove this job when all the release jobs have been migrated
-  # to consume build artifacts from Main workflow instead of rebuilding.
-  build-release-artifacts:
-    name: Build release artifacts
-    if: ${{ needs.prep-release.outputs.is_valid_release == 'true' }}
-    needs:
-      - prep-release
-    uses: ./.github/workflows/build.yml
-    with:
-      BRANCH_REF: ${{ needs.prep-release.outputs.semver_tag }}
+        run: uv run glf-dev release gh-workflow-check
 
   publish-docs:
     name: Publish Docs
@@ -95,7 +84,7 @@ jobs:
           name: docs-site
           path: site
       - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@v4.8.0
+        uses: JamesIves/github-pages-deploy-action@v4.9.0
         with:
           branch: gh-pages
           folder: site
@@ -120,7 +109,6 @@ jobs:
     if: ${{ needs.prep-release.outputs.is_valid_release == 'true' }}
     needs:
       - prep-release
-      - build-release-artifacts
     runs-on: ubuntu-latest
     environment:
       name: pypi
@@ -140,22 +128,22 @@ jobs:
       - name: Setup Python ${{ env.UV_PYTHON }} and install dependencies
         run: |
           uv sync --frozen --no-dev --group release
-      # TODO: In a separate PR, consume the build artifact (package-dist) uploaded
-      # in build-release-artifacts instead of rebuilding and verifying the package here.
-      - name: Build and verify the package
-        run: |
-          uv run --no-sync package build
-          uv run --no-sync package verify
+      - name: Download built package
+        uses: actions/download-artifact@v8
+        with:
+          run-id: ${{ needs.prep-release.outputs.target_run_id }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          name: package-dist
+          path: dist
       - name: Publish to PyPI
         run: |
-          uv run --no-sync release pypi
+          uv run --no-sync glf-dev release pypi
 
   publish-to-ghcr:
     name: Publish GHCR
     if: ${{ needs.prep-release.outputs.is_valid_release == 'true' }}
     needs:
       - prep-release
-      - build-release-artifacts
       - publish-to-pypi
     runs-on: ubuntu-latest
     steps:

{gitlabform-6.2.0 → gitlabform-6.2.2}/.github/workflows/build.yml

@@ -28,8 +28,8 @@ jobs:
         run: uv sync --frozen --no-dev --group release
       - name: Build and verify the package
         run: |
-          uv run --no-sync package build
-          uv run --no-sync package verify
+          uv run --no-sync glf-dev package build
+          uv run --no-sync glf-dev package verify
       - name: Upload package distribution
         uses: actions/upload-artifact@v7
         with:
@@ -52,7 +52,7 @@ jobs:
       - name: Install dependencies
         run: uv sync --frozen --no-dev --group docs
       - name: Build documentation
-        run: uv run --no-sync docs build
+        run: uv run --no-sync glf-dev docs build
       - name: Upload docs site
         uses: actions/upload-artifact@v7
         with:

{gitlabform-6.2.0 → gitlabform-6.2.2}/.github/workflows/pr-ci-workflow.yml

@@ -77,7 +77,7 @@ jobs:
     #   uses: actions/setup-example@v1
 
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v4
+      uses: github/codeql-action/init@v4.38.0
       with:
         languages: ${{ matrix.language }}
         build-mode: ${{ matrix.build-mode }}
@@ -89,6 +89,6 @@ jobs:
         # queries: security-extended,security-and-quality
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v4
+      uses: github/codeql-action/analyze@v4.38.0
       with:
         category: "/language:${{matrix.language}}"

{gitlabform-6.2.0 → gitlabform-6.2.2}/.github/workflows/static-analysis.yml

@@ -48,9 +48,9 @@ jobs:
       - name: Run ${{ matrix.check }}
         run: |
           if [ "${{ matrix.check }}" == "black" ]; then
-            uv run --no-sync qa lint black --check .
+            uv run --no-sync glf-dev qa lint black --check .
           elif [ "${{ matrix.check }}" == "mypy" ]; then
-            uv run --no-sync qa lint mypy .
+            uv run --no-sync glf-dev qa lint mypy .
           elif [ "${{ matrix.check }}" == "bandit" ]; then
-            uv run --no-sync qa lint bandit .
+            uv run --no-sync glf-dev qa lint bandit .
           fi

{gitlabform-6.2.0 → gitlabform-6.2.2}/.github/workflows/tests-acceptance.yml

@@ -39,9 +39,9 @@ jobs:
       - name: Install dependencies
         run: uv sync --frozen --no-dev --group test
       - name: Start GitLab (${{ matrix.flavor }}) in docker
-        run: uv run --no-sync gitlab-local up --gitlab-flavor ${{ matrix.flavor }}
+        run: uv run --no-sync glf-dev gitlab-local up --gitlab-flavor ${{ matrix.flavor }}
       - name: Run Standard acceptance tests for ${{ matrix.flavor }} flavor
-        run: uv run --no-sync qa test tests/acceptance/standard --cov=. --cov-report=xml --durations=0 --reruns 3 --reruns-delay 10 --log-cli-level=WARNING
+        run: uv run --no-sync glf-dev qa test tests/acceptance/standard --cov=. --cov-report=xml --durations=0 --reruns 3 --reruns-delay 10 --log-cli-level=WARNING
       - name: Save PR metadata
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}
@@ -80,9 +80,9 @@ jobs:
       - name: Start GitLab (${{ matrix.tier }}) in docker
         env:
           GITLAB_EE_LICENSE: "${{ matrix.tier == 'premium' && secrets.GITLAB_EE_LICENSE || secrets.GITLAB_EE_ULTIMATE_LICENSE }}"
-        run: uv run --no-sync gitlab-local up
+        run: uv run --no-sync glf-dev gitlab-local up
       - name: Run acceptance Tests for ${{ matrix.tier }} features
-        run: uv run --no-sync qa test tests/acceptance/${{ matrix.tier }} --cov=. --cov-report=xml --durations=0 --reruns 3 --reruns-delay 10 --log-cli-level=WARNING
+        run: uv run --no-sync glf-dev qa test tests/acceptance/${{ matrix.tier }} --cov=. --cov-report=xml --durations=0 --reruns 3 --reruns-delay 10 --log-cli-level=WARNING
       - name: Save PR metadata
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}

{gitlabform-6.2.0 → gitlabform-6.2.2}/.github/workflows/tests-unit.yml

@@ -32,7 +32,7 @@ jobs:
       - name: Install dependencies
         run: uv sync --frozen --no-dev --group test
       - name: Run unit tests
-        run: uv run --no-sync qa test tests/unit --cov=. --cov-report=xml --log-cli-level=WARNING
+        run: uv run --no-sync glf-dev qa test tests/unit --cov=. --cov-report=xml --log-cli-level=WARNING
       - name: Save PR metadata
         env:
           PR_NUMBER: ${{ github.event.pull_request.number }}

gitlabform-6.2.2/.python-version

@@ -0,0 +1 @@
+3.14.6

{gitlabform-6.2.0 → gitlabform-6.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: gitlabform
-Version: 6.2.0
+Version: 6.2.2
 Summary: 🏗 Specialized configuration as a code tool for GitLab projects, groups and more using hierarchical configuration written in YAML
 Project-URL: Homepage, https://gitlabform.github.io/gitlabform/
 Project-URL: Repository, https://github.com/gitlabform/gitlabform.git
@@ -19,14 +19,14 @@ Classifier: Operating System :: POSIX :: Linux
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Topic :: Software Development :: Version Control :: Git
 Requires-Python: >=3.12.0
-Requires-Dist: certifi==2026.6.17
+Requires-Dist: certifi==2026.7.22
 Requires-Dist: cli-ui==0.19.0
 Requires-Dist: jinja2==3.1.6
 Requires-Dist: luddite==1.0.4
 Requires-Dist: markupsafe==3.0.3
 Requires-Dist: mergedeep==1.3.4
-Requires-Dist: packaging==26.2
-Requires-Dist: python-gitlab[graphql]==8.4.0
+Requires-Dist: packaging==26.3
+Requires-Dist: python-gitlab[graphql]==8.5.0
 Requires-Dist: requests==2.34.2
 Requires-Dist: rich==15.0.0
 Requires-Dist: ruamel-yaml==0.19.1

{gitlabform-6.2.0 → gitlabform-6.2.2}/dev/docs.py

@@ -7,17 +7,17 @@ def docs_serve(extra_args: list[str] | None = None):
     """Starts the local documentation development server with live-reloading.
 
     Args:
-        extra_args: Additional arguments for mkdocs serve.
+        extra_args: Additional arguments for zensical serve.
     """
-    cmd = ["uv", "run", "mkdocs", "serve", "--livereload"] + (extra_args or [])
-    run_command(cmd, "Starting MkDocs development server")
+    cmd = ["uv", "run", "zensical", "serve"] + (extra_args or [])
+    run_command(cmd, "Starting Zensical development server")
 
 
 def docs_build(extra_args: list[str] | None = None):
     """Generates the static documentation site.
 
     Args:
-        extra_args: Additional arguments for mkdocs build.
+        extra_args: Additional arguments for zensical build.
     """
-    cmd = ["uv", "run", "mkdocs", "build"] + (extra_args or [])
+    cmd = ["uv", "run", "zensical", "build", "--clean", "--strict"] + (extra_args or [])
     run_command(cmd, "Building static documentation site")

{gitlabform-6.2.0 → gitlabform-6.2.2}/dev/gitlab/run_gitlab_in_docker.sh

@@ -219,7 +219,7 @@ echo ''
 
 # Provide instructions for stopping and starting GitLab
 cecho b 'To stop and delete the GitLab container, run:'
-cecho y 'uv run gitlab-local down'
+cecho y 'uv run glf-dev gitlab-local down'
 echo ''
 cecho b 'Alternatively to do it manually, you can run:'
 cecho r "docker stop --time=30 gitlab"
@@ -232,5 +232,5 @@ cecho b '(This is the only way to make GitLab in Docker stable.)'
 echo ''
 
 cecho b 'To start the acceptance tests, run:'
-cecho y 'uv run qa test tests/acceptance'
+cecho y 'uv run glf-dev qa test tests/acceptance'
 echo ''

{gitlabform-6.2.0 → gitlabform-6.2.2}/dev/main.py

@@ -2,12 +2,23 @@
 """Central entry point and CLI facade for the GitLabForm development toolkit."""
 
 import argparse
-import os
 import sys
 from pathlib import Path
+from dev.common import REPO_ROOT
+
+
+def _ensure_repo_context() -> None:
+    """Fail fast unless the command is being run from inside the gitlabform repo."""
+    cwd = Path.cwd().resolve()
+    repo_root = REPO_ROOT.resolve()
+    if cwd == repo_root or repo_root in cwd.parents:
+        return
+
+    print("glf-dev: this command must be run from inside the gitlabform repository.", file=sys.stderr)
+    print(f"Current directory: {cwd}", file=sys.stderr)
+    print(f"Expected repo root: {repo_root}", file=sys.stderr)
+    raise SystemExit(2)
 
-# Add the project root to sys.path to allow running this script directly
-sys.path.append(str(Path(__file__).resolve().parent.parent))
 
 from dev.docs import docs_build, docs_serve
 from dev.env import clean as run_clean_logic, setup as run_setup_logic
@@ -67,16 +78,16 @@ def _add_docs_subcommands(subparsers):
     serve = subparsers.add_parser(
         "serve",
         help="Start the documentation server with live-reload",
-        description="Start the MkDocs live-reload server. Provides an interactive preview of the documentation at http://localhost:8000.",
+        description="Start the Zensical live-reload server. Provides an interactive preview of the documentation at http://localhost:8000.",
     )
-    serve.add_argument("extra_args", nargs=argparse.REMAINDER, help="Additional arguments for mkdocs serve")
+    serve.add_argument("extra_args", nargs=argparse.REMAINDER, help="Additional arguments for zensical serve")
 
     build_p = subparsers.add_parser(
         "build",
         help="Generate the static documentation site",
         description="Compile the markdown documentation into a static HTML site ready for deployment.",
     )
-    build_p.add_argument("extra_args", nargs=argparse.REMAINDER, help="Additional arguments for mkdocs build")
+    build_p.add_argument("extra_args", nargs=argparse.REMAINDER, help="Additional arguments for zensical build")
 
 
 def _dispatch_docs(args):
@@ -246,67 +257,9 @@ def _dispatch_qa(args):
         run_test_logic(args.extra_args)
 
 
-# --- Domain Shortcut Entry Points ---
-
-
-def _domain_entrypoint(prog, description, setup_fn, dispatch_fn):
-    """Generic helper for domain-specific entry points."""
-    parser = argparse.ArgumentParser(prog=prog, description=description)
-    setup_fn(parser.add_subparsers(dest="command"))
-    args, extra = parser.parse_known_args()
-
-    # Combine unknown arguments (like flags) with the 'extra_args' list if it exists.
-    # This allows passthrough commands like 'up' to receive flags like --help.
-    if hasattr(args, "extra_args") and extra:
-        if args.extra_args is None:
-            args.extra_args = extra
-        else:
-            args.extra_args = extra + args.extra_args
-
-    if not args.command:
-        parser.print_help()
-        sys.exit(0)
-
-    dispatch_fn(args)
-
-
-def workspace():
-    """Shortcut for 'uv run workspace'."""
-    _domain_entrypoint("workspace", DESC_WORKSPACE, _add_workspace_subcommands, _dispatch_workspace)
-
-
-def qa():
-    """Shortcut for 'uv run qa'."""
-    _domain_entrypoint("qa", DESC_QA, _add_qa_subcommands, _dispatch_qa)
-
-
-def docs():
-    """Shortcut for 'uv run docs'."""
-    _domain_entrypoint("docs", DESC_DOCS, _add_docs_subcommands, _dispatch_docs)
-
-
-def package():
-    """Shortcut for 'uv run package'."""
-    _domain_entrypoint("package", DESC_PACKAGE, _add_package_subcommands, _dispatch_package)
-
-
-def docker():
-    """Shortcut for 'uv run docker'."""
-    _domain_entrypoint("docker", DESC_DOCKER, _add_docker_subcommands, _dispatch_docker)
-
-
-def release():
-    """Shortcut for 'uv run release'."""
-    _domain_entrypoint("release", DESC_RELEASE, _add_release_subcommands, _dispatch_release)
-
-
-def gitlab_local():
-    """Shortcut for 'uv run gitlab-local'. Provides orchestration for the local GitLab instance."""
-    _domain_entrypoint("gitlab-local", DESC_INFRA, _add_infra_subcommands, _dispatch_infra)
-
-
 def main():
     """Main entry point for direct script execution."""
+    _ensure_repo_context()
     parser = argparse.ArgumentParser(description="GitLabForm Development Toolkit")
     subparsers = parser.add_subparsers(dest="domain", help="Task domains")
 
@@ -335,7 +288,7 @@ def main():
     args, extra = parser.parse_known_args()
 
     # Combine unknown arguments (flags) with the 'extra_args' list if it exists.
-    # This applies when running via the main 'dev' entrypoint.
+    # This applies when running via the main 'glf-dev' entrypoint.
     if hasattr(args, "extra_args") and extra:
         if args.extra_args is None:
             args.extra_args = extra

{gitlabform-6.2.0 → gitlabform-6.2.2}/dev/package.py

@@ -29,7 +29,7 @@ def python_verify(extra_args: list[str] | None = None):
     # 1. Ensure build artifacts exist
     if not dist_path.exists() or not any(dist_path.iterdir()):
         logger.error(f"[bold red]❌ Build directory '{dist_path}/' is missing or empty.[/bold red]")
-        logger.info("Hint: Run [bold cyan]uv run package build[/bold cyan] first.")
+        logger.info("Hint: Run [bold cyan]uv run glf-dev package build[/bold cyan] first.")
         sys.exit(1)
 
     wheels = [str(p) for p in dist_path.glob("*.whl")]

{gitlabform-6.2.0 → gitlabform-6.2.2}/dev/release.py

@@ -143,11 +143,11 @@ def gh_workflow_check(extra_args: list[str] | None = None):
 
     LOCAL TESTING:
     1. Manual Trigger:
-       GH_TOKEN="your_pat" EVENT="workflow_dispatch" REPO="owner/repo" MANUAL_RELEASE_TAG="v1.0.0" MANUAL_UPSTREAM_RUN_ID="12345" uv run release gh-workflow-check
+       GH_TOKEN="your_pat" EVENT="workflow_dispatch" REPO="owner/repo" MANUAL_RELEASE_TAG="v1.0.0" MANUAL_UPSTREAM_RUN_ID="12345" uv run glf-dev release gh-workflow-check
 
     2. Automated Trigger:
        GH_TOKEN="your_pat" EVENT="workflow_run" REPO="owner/repo" CONCLUSION="success" \
-       SHA="$(git rev-parse HEAD)" AUTOMATED_UPSTREAM_RUN_ID="67890" uv run release gh-workflow-check
+       SHA="$(git rev-parse HEAD)" AUTOMATED_UPSTREAM_RUN_ID="67890" uv run glf-dev release gh-workflow-check
     """
     event_name = os.environ.get("EVENT")
     repo = os.environ.get("REPO")

{gitlabform-6.2.0 → gitlabform-6.2.2}/docs/changelog.md

@@ -6,6 +6,55 @@ For details on how to migrate between major versions, please refer to the [upgra
 
 ---
 
+## 6.2.2
+
+### Bug Fixes
+
+* prevent KeyError when using --output with application settings [#1384](https://github.com/gitlabform/gitlabform/pull/1384). ([rickbrouwer](https://github.com/rickbrouwer))
+
+### Documentation
+
+* use renamed secret_push_protection_enabled setting [#1395](https://github.com/gitlabform/gitlabform/pull/1395). ([rickbrouwer](https://github.com/rickbrouwer))
+* fix Snyk badge and add ti&m logo [#1371](https://github.com/gitlabform/gitlabform/pull/1371). ([marcelstoer](https://github.com/marcelstoer))
+
+### Refactors
+
+* migrate badges processor to python-gitlab [#1388](https://github.com/gitlabform/gitlabform/pull/1388). ([rickbrouwer](https://github.com/rickbrouwer))
+* centralize dry-run diff in AbstractProcessor [#1353](https://github.com/gitlabform/gitlabform/pull/1353). ([rickbrouwer](https://github.com/rickbrouwer))
+
+### Build
+
+* migrate documentation from MkDocs Material to Zensical [#1372](https://github.com/gitlabform/gitlabform/pull/1372). ([rickbrouwer](https://github.com/rickbrouwer))
+* replace gitlabform development toolkit shortcuts with one entrypoint [#1409](https://github.com/gitlabform/gitlabform/pull/1409). ([amimas](https://github.com/amimas))
+
+### Chores
+
+* update default PR reviewers [#1375](https://github.com/gitlabform/gitlabform/pull/1375). ([rickbrouwer](https://github.com/rickbrouwer))
+
+### Dependencies
+
+* Update various dependencies to newer versions.
+
+Thanks to all the contributors of this release!
+
+## 6.2.1
+
+### Bug Fixes
+
+* catch GitlabCreateError and GitlabDeleteError when modifying files on protected branches [#1361](https://github.com/gitlabform/gitlabform/pull/1361). ([haijeploeg](https://github.com/haijeploeg))
+* fix merge_request_approval_rules to stop redundant edit calls on unchanged rules [#1350](https://github.com/gitlabform/gitlabform/pull/1350). ([rickbrouwer](https://github.com/rickbrouwer))
+* use add instead of delete in commit message for new files to reflect what actually happened in commit history [#1363](https://github.com/gitlabform/gitlabform/pull/1363). ([rickbrouwer](https://github.com/rickbrouwer))
+
+### Build
+
+* consume package artifact from main workflow in pypi release [#1327](https://github.com/gitlabform/gitlabform/pull/1327). ([amimas](https://github.com/amimas))
+
+### Dependencies
+
+* Update various dependencies to newer versions.
+
+Thanks to all the contributors of this release!
+
 ## 6.2.0
 
 ### Features

{gitlabform-6.2.0 → gitlabform-6.2.2}/docs/contrib/coding_guidelines.md

@@ -6,6 +6,13 @@ Please do:
 * add tests along with the new code that prove that it works:
     * when adding/changing non-trivial logic please add unit tests,
     * for all bug fixes and new features using GitLab API please add acceptance tests
+* use INFO as the base log level, DEBUG only if you might expose sensitive information (such as raw API request/responses)
+    * [Logging levels information](https://docs.python.org/3/howto/logging.html#logging-levels)
+    * by default we log WARNING and above issues; INFO is logged when specifying the `--verbose` argument in CLI
+    * diff output is emitted via a dedicated `DIFF` log level and does not require `--verbose`
+    * use the `logging` module for logging, do not use `print` statements
+    * we have a custom log level for "diff" messages, used only in the `difference_logger`
+    * we have a custom log level "notice" used only in `gitlabform.__init__` in order to output version information and the total numbers of Projects/Groups processed
 * add or update the docs for new features,
 * use [pre-commit](https://pre-commit.com) to automatically reformat your code and run linters before committing,
 * squash your commits (unless there is a reason not to),