gitlabform 5.3.0__tar.gz → 5.5.0__tar.gz

gitlabform-5.5.0/.coveragerc

@@ -0,0 +1,15 @@
+[run]
+source =
+    gitlabform
+
+omit =
+    # don't check the test themselves, obviously
+    tests/*
+
+    # no point in checking this
+    setup.py
+
+[report]
+exclude_also =
+    \s*debug\(.*\)
+    \s*fatal\(.*\)

gitlabform-5.5.0/.dockerignore

@@ -0,0 +1,46 @@
+# Git
+.git
+.gitignore
+.git-blame-ignore-revs
+
+# Docker
+.dockerignore
+Dockerfile
+
+# Python cache and artifacts
+*.pyc
+__pycache__/
+*.egg-info
+.mypy_cache/
+.pytest_cache/
+
+# Test, dev, and local environments
+tests/
+dev/
+venv/
+.venv/
+
+# Documentation
+docs/
+.overrides/
+mkdocs.yml
+*.txt
+*.md
+
+# CI/CD and project config
+.github/
+.pre-commit-config.yaml
+.coveragerc
+codecov.yml
+.lgtm.yml
+.mypy.ini
+coverage.xml
+tbump.toml
+
+# Editor/IDE config
+.idea/
+.vscode/
+.cursor/
+
+# Exceptions
+!README.md

gitlabform-5.5.0/.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+# Migrate code style to Black
+c4ee3944829eda31699d63f55afc2d1a174fc12c
+# Reformat to the latest version of Black with 120 chars per line
+7915da0bee431bdbddbcb47bde947161adb95148

gitlabform-5.5.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @amimas @gdubicki @jimisola @TimKnight-DWP

gitlabform-5.5.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+
+A clear and concise description of what the bug is.
+
+**GitLabForm version**
+
+Output of `gitlabform -V`
+
+**GitLab version**
+
+F.e. `13.12.4-ee`

gitlabform-5.5.0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,10 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+A clear and concise description of what you want to happen.

gitlabform-5.5.0/.github/ISSUE_TEMPLATE/question-or-other-issue.md

@@ -0,0 +1,10 @@
+---
+name: Question or other issue
+about: Non-bug and non-feature requests go here :)
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Write whatever you like :)

gitlabform-5.5.0/.github/actions/setup-uv-local/README.md

@@ -0,0 +1,42 @@
+# Setup uv Local
+
+This internal composite action centrally manages the installation of `uv` and configures the environment variables required for the project's toolchain.
+
+## Purpose
+
+Instead of repeating installation scripts and version pinning in every workflow file, this action provides a single source of truth for:
+- The pinned `uv` version (currently `0.11.7`).
+- Option to set the Python version used in CI job.
+- Cross-platform installation logic (handling both Unix and Windows runners).
+
+## Inputs
+
+| Name | Description | Default | Required |
+| :--- | :--- | :--- | :--- |
+| `python-version` | The Python version to use (e.g., `3.12`, `3.14`). | `3.14` | No |
+
+## Environment Variables Set
+
+This action exports the following variables to the `$GITHUB_ENV`, making them available to all subsequent steps in the job:
+- `UV_PYTHON`: The version of Python `uv` should use for toolchain management.
+- `UV_VERSION`: The pinned version of `uv` installed.
+
+## Usage
+
+To use this action in a workflow, reference it by its local path:
+
+```yaml
+jobs:
+  my-job:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+        with:
+          python-version: '3.12'
+          
+      - name: Install dependencies
+        run: uv sync
+```

gitlabform-5.5.0/.github/actions/setup-uv-local/action.yml

@@ -0,0 +1,30 @@
+name: 'Setup uv Local'
+description: 'Centrally manages uv installation and versioning'
+inputs:
+  python-version:
+    description: 'Python version to use. Defaults to 3.14 if not provided.'
+    required: false
+    default: '3.14'
+runs:
+  using: 'composite'
+  steps:
+    - name: Export UV_PYTHON to environment
+      shell: bash
+      run: |
+        echo "UV_PYTHON=${{ inputs.python-version }}" >> $GITHUB_ENV
+        echo "UV_VERSION=0.11.7" >> $GITHUB_ENV
+
+    - name: Install uv (Unix)
+      if: runner.os != 'Windows'
+      shell: bash
+      run: |
+        curl -LsSf https://astral.sh/uv/${{ env.UV_VERSION }}/install.sh | sh
+        echo "$HOME/.local/bin" >> $GITHUB_PATH
+
+    - name: Install uv (Windows)
+      if: runner.os == 'Windows'
+      shell: pwsh
+      run: |
+        $env:UV_VERSION = "${{ env.UV_VERSION }}"
+        irm https://astral.sh/uv/install.ps1 | iex
+        echo "$HOME\.local\bin" >> $env:GITHUB_PATH

gitlabform-5.5.0/.github/dependabot.yml

@@ -0,0 +1,52 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    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:
+        patterns:
+          - "pytest*"
+          - "coverage"
+          - "cryptography"
+          - "deepdiff"
+          - "xkcdpass"
+      linting:
+        patterns:
+          - "bandit"
+          - "black"
+          - "codespell"
+          - "mypy*"
+          - "ruff"
+          - "types-*"
+      documentation:
+        patterns:
+          - "markdown*"
+          - "mkdocs*"
+          - "pygments"
+          - "pymdown-extensions"
+      release-tools:
+        patterns:
+          - "check-wheel-contents"
+          - "twine"
+          - "commitizen"
+          - "prek"

gitlabform-5.5.0/.github/workflows/_main.yml

@@ -0,0 +1,48 @@
+name: Main branch
+
+permissions:
+  actions: read
+  checks: read
+  contents: read
+  discussions: write
+  statuses: write
+
+concurrency:
+  group: ${{github.workflow}}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+
+  build-docs:
+    uses: ./.github/workflows/docs.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+
+  linters:
+    uses: ./.github/workflows/linters.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+
+  tests-standard:
+    uses: ./.github/workflows/tests-standard.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+
+  tests-premium:
+    uses: ./.github/workflows/tests-premium.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+      environment: Main Tests
+    secrets: inherit
+
+  tests-ultimate:
+    uses: ./.github/workflows/tests-ultimate.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+      environment: Main Tests
+    secrets: inherit

gitlabform-5.5.0/.github/workflows/_releases.yml

@@ -0,0 +1,160 @@
+name: Releases
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: write
+  packages: write
+
+jobs:
+
+  linters:
+    uses: ./.github/workflows/linters.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+
+  tests-standard:
+    uses: ./.github/workflows/tests-standard.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+
+  tests-premium:
+    uses: ./.github/workflows/tests-premium.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+      environment: Main Tests
+    secrets: inherit
+
+  tests-ultimate:
+    uses: ./.github/workflows/tests-ultimate.yml
+    with:
+      BRANCH_REF: ${{ github.ref }}
+      environment: Main Tests
+    secrets: inherit
+
+  publish-docs:
+    needs:
+      - linters
+      - tests-standard
+      - tests-premium
+      - tests-ultimate
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 2
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+      - name: Setup Python ${{ env.UV_PYTHON }} and install dependencies
+        run: |
+          uv sync --frozen --no-dev --group docs
+      - name: Build docs
+        run: |
+          uv run --no-sync docs build
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@v4.8.0
+        with:
+          branch: gh-pages
+          folder: site
+
+  publish-to-github:
+    needs:
+      - linters
+      - tests-standard
+      - tests-premium
+      - tests-ultimate
+    runs-on: ubuntu-latest
+    steps:
+      - name: Create release in GitHub
+        uses: ncipollo/release-action@v1
+        with:
+          name: ${{ github.ref }}
+          body: "(this is a placeholder, it will be replaced with a changelog contents)"
+          # This token is provided by Actions, you do not need to create your own token
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  publish-to-pypi:
+    needs:
+      - linters
+      - tests-standard
+      - tests-premium
+      - tests-ultimate
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/gitlabform
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ github.ref }}
+          fetch-depth: 2
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+      - name: Setup Python ${{ env.UV_PYTHON }} and install dependencies
+        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
+      - name: Publish to PyPI
+        run: |
+          uv run --no-sync package publish
+
+  publish-to-ghcr:
+    needs:
+      - linters
+      - tests-standard
+      - tests-premium
+      - tests-ultimate
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+      - name: Get the version from the tag
+        run: echo "VERSION=${GITHUB_REF/refs\/tags\/v/}" >> $GITHUB_ENV
+      - name: Wait for PyPI release
+        run: |
+          uv pip download gitlabform==${{ env.VERSION }} > /dev/null
+          while [ $? -ne 0 ]; do sleep 10; uv pip download gitlabform==${{ env.VERSION }} > /dev/null ; done
+        shell: bash {0}
+      - name: Docker metadata
+        id: metadata
+        uses: docker/metadata-action@v6
+        with:
+          images: |
+            ghcr.io/gitlabform/gitlabform
+          flavor: |
+            latest=auto
+          tags: |
+            type=pep440,pattern={{version}}
+            type=pep440,pattern={{major}}.{{minor}}
+            type=pep440,pattern={{major}}
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v4
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v4
+      # gitlabform/gitlabform image is going to be here
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v4
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          # This token is provided by Actions, you do not need to create your own token
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Publish image to registries
+        uses: docker/build-push-action@v7
+        with:
+          push: true
+          context: .
+          file: Dockerfile
+          platforms: linux/amd64,linux/arm64
+          tags: ${{ steps.metadata.outputs.tags }}
+          labels: ${{ steps.metadata.outputs.labels }}

gitlabform-5.5.0/.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: Docs
+
+on:
+  workflow_call:
+    inputs:
+      BRANCH_REF:
+        type: string
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ inputs.BRANCH_REF }}
+          fetch-depth: 2
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+      - name: Setup Python ${{ env.UV_PYTHON }} and install dependencies
+        run: |
+          uv sync --frozen --no-dev --group docs
+      - name: Build documentation
+        run: |
+          uv run --no-sync docs build

gitlabform-5.5.0/.github/workflows/linters.yml

@@ -0,0 +1,67 @@
+name: Linters
+
+on:
+  workflow_call:
+    inputs:
+      BRANCH_REF:
+        type: string
+        required: true
+
+permissions:
+  contents: read
+
+jobs:
+  black-formatting:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ inputs.BRANCH_REF }}
+          fetch-depth: 2
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+      - name: Setup Python ${{ env.UV_PYTHON }} and install dependencies
+        run: |
+          uv sync --frozen --no-dev --group lint
+      - name: Run black formatting check
+        run: |
+          uv run --no-sync qa lint black --check .
+
+  types:
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 1
+      matrix:
+        python-version: [3.14]
+      fail-fast: false
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ inputs.BRANCH_REF }}
+          fetch-depth: 2
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Setup Python ${{ matrix.python-version }} and install dependencies
+        run: |
+          uv sync --frozen --no-dev --group lint
+      - name: Run mypy
+        run: |
+          uv run --no-sync qa lint mypy .
+
+  bandit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          ref: ${{ inputs.BRANCH_REF }}
+          fetch-depth: 2
+      - name: Configure uv environment
+        uses: ./.github/actions/setup-uv-local
+      - name: Setup Python ${{ env.UV_PYTHON }} and install dependencies
+        run: |
+          uv sync --frozen --no-dev --group lint
+      - name: Run bandit
+        run: |
+          uv run --no-sync qa lint bandit .

gitlabform-5.5.0/.github/workflows/pr_on_fork.yml

@@ -0,0 +1,29 @@
+name: Linter and tests (PRs raised from Forks)
+
+permissions:
+  actions: read
+  contents: read
+  pull-requests: write
+concurrency:
+  group: ${{github.workflow}}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+on:
+  pull_request_target:
+    branches:
+      - main
+
+jobs:
+  pr_jobs:
+    # github.event.pull_request object defined here: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2026-03-10#get-a-pull-request
+    if: ${{ github.event.pull_request.head.repo.full_name != 'gitlabform/gitlabform' }}
+    uses: ./.github/workflows/prs.yml
+    permissions:
+      actions: read
+      contents: read
+      packages: read
+      pull-requests: write
+      security-events: write
+    with:
+      branch_ref: ${{ github.event.pull_request.head.sha }}
+    secrets: inherit

gitlabform-5.5.0/.github/workflows/pr_on_main_repo.yml

@@ -0,0 +1,29 @@
+name: Linter and tests (PRs raised on main repo)
+
+permissions:
+  actions: read
+  contents: read
+  pull-requests: write
+concurrency:
+  group: ${{github.workflow}}-${{ github.event.pull_request.number }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  pr_jobs:
+    # github.event.pull_request object defined here: https://docs.github.com/en/rest/pulls/pulls?apiVersion=2026-03-10#get-a-pull-request
+    if: ${{ github.event.pull_request.head.repo.full_name == 'gitlabform/gitlabform' }}
+    uses: ./.github/workflows/prs.yml
+    permissions:
+      actions: read
+      contents: read
+      packages: read
+      pull-requests: write
+      security-events: write
+    with:
+      branch_ref: ${{ github.event.pull_request.head.sha }}
+    secrets: inherit