gitlab-compliance 2.0.1__tar.gz → 2.1.0__tar.gz

gitlab_compliance-2.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 DevOps Contracting Limited trading as Maturity Builder
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

gitlab_compliance-2.1.0/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: gitlab-compliance
+Version: 2.1.0
+Summary: BDD compliance testing for GitLab CI/CD pipelines and project settings — by MaturityBuilder
+License-Expression: Apache-2.0
+License-File: LICENSE
+Author: Charlie Smith
+Author-email: me@charlieasmith.co.uk
+Requires-Python: >=3.12
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Dist: behave (>=1.2.6,<2.0.0)
+Requires-Dist: click (>=8.1.8,<9.0.0)
+Requires-Dist: idna (==3.18)
+Requires-Dist: jq (==1.12.0)
+Requires-Dist: loguru (==0.7.2)
+Requires-Dist: markdown-analysis (==0.1.5)
+Requires-Dist: oras (==0.2.42)
+Requires-Dist: oyaml
+Requires-Dist: prettytable
+Requires-Dist: pytablewriter (==1.2.1)
+Requires-Dist: python-gitlab (==8.4.0)
+Requires-Dist: pyyaml (==6.0.3)
+Requires-Dist: requests (==2.34.2)
+Requires-Dist: rich (==15.0.0)
+Requires-Dist: semver (==3.0.4)
+Requires-Dist: typer (==0.27.0)
+Requires-Dist: urllib3 (==2.7.0)
+Project-URL: Documentation, https://maturitybuilder.github.io/gitlab-compliance/
+Project-URL: Home Page, https://maturitybuilder.github.io/gitlab-compliance/
+Project-URL: Repository, https://github.com/MaturityBuilder/gitlab-compliance
+Description-Content-Type: text/markdown
+
+---
+layout: home
+title: Overview
+permalink: /
+---
+# Gitlab Compliance
+
+<img src="https://maturitybuilder.github.io/gitlab-compliance/assets/logo-light.png" align="right" width="350" valign="top" style="max-width:100%; margin-top: 50px; text-align: justify;">
+<div align="left">
+  <!-- <a href="https://github.com/gitlab-compliance/cli/actions/workflows/cd.yml">
+    <img src="https://github.com/eerkunt/gitlab-compliance/workflows/CD/badge.svg" alt="Build" />
+  </a> -->
+  <a href="https://hub.docker.com/r/maturitybuilder/gitlab-compliance/">
+    <img src="https://img.shields.io/badge/docker-ready-blue.svg?longCache=true&style=flat" alt="docker version is ready" />
+    <img alt="Docker Image Version" src="https://img.shields.io/docker/v/maturitybuilder/gitlab-compliance?label=Docker Latest">
+  </a>
+  <a href="https://pypi.org/project/gitlab-compliance/">
+    <!-- <img src="https://maturitybuilder.github.io/gitlab-compliance/assets/logo-light.png" alt="License" /> -->
+  </a>
+  <a href="https://pypi.org/project/gitlab-compliance/">
+    <img src="https://img.shields.io/pypi/v/gitlab-compliance.svg" alt="Package Version" />
+  </a>
+</div>
+
+<p class="mb-tagline">Gitlab Compliance is a BDD compliance testing and documentation generation toolkit for GitLab CI/CD pipelines and project settings. It runs Gherkin policies against `.gitlab-ci.yml` and optional GitLab API settings. You can also generate markdown documentation for your Gitlab pipelines.</p>
+
+
+Source code - coming soon:
+[MaturityBuilder/gitlab-compliance](https://github.com/MaturityBuilder/gitlab-compliance).
+
+## Get started
+[Get started](installation/index.md){ .md-button .md-button-primary }
+[Usage](usage/index.md){ .md-button }
+[BDD grammar](bdd-reference/index.md){ .md-button }
+
+`gitlab-compliance` supports two core workflows from the same pipeline YAML:
+
+| Workflow | Command | What it does |
+| -------- | ------- | ------------ |
+| **Compliance** | [`check`](usage/reference/check.md) | Run Gherkin policies against `.gitlab-ci.yml` (and optional GitLab API settings) |
+| **Documentation** | [`generate`](usage/reference/generate.md) | Build Markdown, swagger-markdown, or HTML reference docs from `.gitlab-ci.yml` |
+
+![gitlab-compliance check console demo](demos/gifs/check-console.gif)
+
+```bash
+pip install gitlab-compliance
+
+# Validate pipeline configuration against policies
+gitlab-compliance check -f policies/ -p .gitlab-ci.yml
+
+# Generate pipeline documentation (filter and group output as needed)
+gitlab-compliance generate -i .gitlab-ci.yml --format swagger-markdown -o pipeline-reference.md
+gitlab-compliance generate -i .gitlab-ci.yml --exclude variables,image --group-by stage
+```
+
+See [Usage](usage/index.md) for the full CLI (including demos) and
+[Generate pipeline documentation](usage/reference/generate.md) for output
+formats, `--exclude`, and `--group-by`.
+
+- **compliance:** Ensure pipeline YAML and project settings follow your security
+  standards and custom policies
+- **behaviour driven development:** Policies are readable Gherkin scenarios that
+  developers and security teams share
+- **portable:** Install from `pip`. See [Installation](installation/index.md)
+- **pre-merge:** Validate configuration before changes land on protected
+  branches
+- **YAML and API:** Offline checks against pipeline files; optional GitLab API
+  checks for project settings and CI variables
+- **easy to integrate:** Run in GitLab CI or local git hooks
+- **segregation of duty:** Keep policy packs in a separate repository or OCI
+  registry
+- **documentation:** Generate Markdown or HTML reference docs from
+  `.gitlab-ci.yml`
+
+## Idea
+
+`gitlab-compliance` focuses on [negative
+testing](https://en.wikipedia.org/wiki/Negative_testing) — catching
+misconfigurations and policy violations — rather than proving that a job runs
+successfully end to end.
+
+GitLab CI pipelines are defined in YAML that composes jobs, includes, variables,
+and workflow rules. What was missing is a lightweight way to assert that this
+configuration follows organizational standards before merge. GitLab offers
+native compliance features in higher tiers; `gitlab-compliance` provides an
+open, portable alternative inspired by
+[terraform-compliance](https://terraform-compliance.com/) and
+[Conftest](https://www.conftest.dev/).
+
+For example, a policy might require that no job uses a floating `latest` image
+tag:
+
+```gherkin
+if a job defines an image, it must not use the :latest tag
+```
+
+translates into:
+
+```gherkin
+Given I have any job defined
+When it has image
+Then its image must not match ":latest$"
+```
+
+The `image` value comes from your pipeline YAML:
+
+```yaml
+scan:
+  image: python:3.12
+build:
+  image: docker:latest   # violates the policy above
+```
+
+In CI, this scenario runs against `.gitlab-ci.yml` (and resolved local includes)
+so merge requests cannot introduce violations.
+
+See [Examples](examples/index.md) for more sample use cases.
+
+## Supporting / Requirements
+
+- **Python:** 3.12 (see [Installing via pip](installation/pip.md))
+- **Pipeline file:** `.gitlab-ci.yml` or another path passed with `-p`
+- **API checks (optional):** GitLab token plus `--project` or `--group` for
+  settings and CI variable policies
+
+Full CLI options: [Usage](usage/index.md). Step grammar: [BDD
+Reference](bdd-reference/index.md).
+
+## How can you support the project?
+
+Contributions are welcome — see [Contributing](contributing.md).
+

gitlab_compliance-2.1.0/docs/index.md

@@ -0,0 +1,131 @@
+---
+layout: home
+title: Overview
+permalink: /
+---
+# Gitlab Compliance
+
+<img src="https://maturitybuilder.github.io/gitlab-compliance/assets/logo-light.png" align="right" width="350" valign="top" style="max-width:100%; margin-top: 50px; text-align: justify;">
+<div align="left">
+  <!-- <a href="https://github.com/gitlab-compliance/cli/actions/workflows/cd.yml">
+    <img src="https://github.com/eerkunt/gitlab-compliance/workflows/CD/badge.svg" alt="Build" />
+  </a> -->
+  <a href="https://hub.docker.com/r/maturitybuilder/gitlab-compliance/">
+    <img src="https://img.shields.io/badge/docker-ready-blue.svg?longCache=true&style=flat" alt="docker version is ready" />
+    <img alt="Docker Image Version" src="https://img.shields.io/docker/v/maturitybuilder/gitlab-compliance?label=Docker Latest">
+  </a>
+  <a href="https://pypi.org/project/gitlab-compliance/">
+    <!-- <img src="https://maturitybuilder.github.io/gitlab-compliance/assets/logo-light.png" alt="License" /> -->
+  </a>
+  <a href="https://pypi.org/project/gitlab-compliance/">
+    <img src="https://img.shields.io/pypi/v/gitlab-compliance.svg" alt="Package Version" />
+  </a>
+</div>
+
+<p class="mb-tagline">Gitlab Compliance is a BDD compliance testing and documentation generation toolkit for GitLab CI/CD pipelines and project settings. It runs Gherkin policies against `.gitlab-ci.yml` and optional GitLab API settings. You can also generate markdown documentation for your Gitlab pipelines.</p>
+
+
+Source code - coming soon:
+[MaturityBuilder/gitlab-compliance](https://github.com/MaturityBuilder/gitlab-compliance).
+
+## Get started
+[Get started](installation/index.md){ .md-button .md-button-primary }
+[Usage](usage/index.md){ .md-button }
+[BDD grammar](bdd-reference/index.md){ .md-button }
+
+`gitlab-compliance` supports two core workflows from the same pipeline YAML:
+
+| Workflow | Command | What it does |
+| -------- | ------- | ------------ |
+| **Compliance** | [`check`](usage/reference/check.md) | Run Gherkin policies against `.gitlab-ci.yml` (and optional GitLab API settings) |
+| **Documentation** | [`generate`](usage/reference/generate.md) | Build Markdown, swagger-markdown, or HTML reference docs from `.gitlab-ci.yml` |
+
+![gitlab-compliance check console demo](demos/gifs/check-console.gif)
+
+```bash
+pip install gitlab-compliance
+
+# Validate pipeline configuration against policies
+gitlab-compliance check -f policies/ -p .gitlab-ci.yml
+
+# Generate pipeline documentation (filter and group output as needed)
+gitlab-compliance generate -i .gitlab-ci.yml --format swagger-markdown -o pipeline-reference.md
+gitlab-compliance generate -i .gitlab-ci.yml --exclude variables,image --group-by stage
+```
+
+See [Usage](usage/index.md) for the full CLI (including demos) and
+[Generate pipeline documentation](usage/reference/generate.md) for output
+formats, `--exclude`, and `--group-by`.
+
+- **compliance:** Ensure pipeline YAML and project settings follow your security
+  standards and custom policies
+- **behaviour driven development:** Policies are readable Gherkin scenarios that
+  developers and security teams share
+- **portable:** Install from `pip`. See [Installation](installation/index.md)
+- **pre-merge:** Validate configuration before changes land on protected
+  branches
+- **YAML and API:** Offline checks against pipeline files; optional GitLab API
+  checks for project settings and CI variables
+- **easy to integrate:** Run in GitLab CI or local git hooks
+- **segregation of duty:** Keep policy packs in a separate repository or OCI
+  registry
+- **documentation:** Generate Markdown or HTML reference docs from
+  `.gitlab-ci.yml`
+
+## Idea
+
+`gitlab-compliance` focuses on [negative
+testing](https://en.wikipedia.org/wiki/Negative_testing) — catching
+misconfigurations and policy violations — rather than proving that a job runs
+successfully end to end.
+
+GitLab CI pipelines are defined in YAML that composes jobs, includes, variables,
+and workflow rules. What was missing is a lightweight way to assert that this
+configuration follows organizational standards before merge. GitLab offers
+native compliance features in higher tiers; `gitlab-compliance` provides an
+open, portable alternative inspired by
+[terraform-compliance](https://terraform-compliance.com/) and
+[Conftest](https://www.conftest.dev/).
+
+For example, a policy might require that no job uses a floating `latest` image
+tag:
+
+```gherkin
+if a job defines an image, it must not use the :latest tag
+```
+
+translates into:
+
+```gherkin
+Given I have any job defined
+When it has image
+Then its image must not match ":latest$"
+```
+
+The `image` value comes from your pipeline YAML:
+
+```yaml
+scan:
+  image: python:3.12
+build:
+  image: docker:latest   # violates the policy above
+```
+
+In CI, this scenario runs against `.gitlab-ci.yml` (and resolved local includes)
+so merge requests cannot introduce violations.
+
+See [Examples](examples/index.md) for more sample use cases.
+
+## Supporting / Requirements
+
+- **Python:** 3.12 (see [Installing via pip](installation/pip.md))
+- **Pipeline file:** `.gitlab-ci.yml` or another path passed with `-p`
+- **API checks (optional):** GitLab token plus `--project` or `--group` for
+  settings and CI variable policies
+
+Full CLI options: [Usage](usage/index.md). Step grammar: [BDD
+Reference](bdd-reference/index.md).
+
+## How can you support the project?
+
+Contributions are welcome — see [Contributing](contributing.md).

{gitlab_compliance-2.0.1 → gitlab_compliance-2.1.0}/pyproject.toml

@@ -1,7 +1,22 @@
 [project]
 name = "gitlab-compliance"
-version = "2.0.1"
+version = "2.1.0"
 dynamic = [ "readme" ]
+license = "Apache-2.0"
+requires-python = ">=3.12"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Intended Audience :: System Administrators",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Quality Assurance",
+  "Topic :: Software Development :: Testing",
+]
 [project.urls]
 "Home Page" = "https://maturitybuilder.github.io/gitlab-compliance/"
 DOCUMENTATION = "https://maturitybuilder.github.io/gitlab-compliance/"
@@ -11,8 +26,9 @@ Repository = "https://github.com/MaturityBuilder/gitlab-compliance"
 
 [tool.poetry]
 name = "gitlab-compliance"
-description = "Gitlab automatically generates gitlab documentation from yaml files"
+description = "BDD compliance testing for GitLab CI/CD pipelines and project settings — by MaturityBuilder"
 authors = ["Charlie Smith <me@charlieasmith.co.uk>"]
+license = "Apache-2.0"
 readme = ["docs/index.md"]
 
 packages = [{ include = "src" }]
@@ -22,20 +38,20 @@ packages = [{ include = "src" }]
 [tool.poetry.dependencies]
 python = ">=3.12"
 prettytable = "*"
-pytablewriter = "1.2.0"
+pytablewriter = "1.2.1"
 oyaml = "*"
-typer = "0.10.0"
+typer = "0.27.0"
 markdown-analysis = "0.1.5"
 urllib3 = "2.7.0"
-jq = "1.8.0"
+jq = "1.12.0"
 click = "^8.1.8"
-semver = "3.0.2"
-pyyaml = "6.0.2"
-loguru = "0.7.0"
-python-gitlab = "7.0.0"
-rich = "14.2.0"
+semver = "3.0.4"
+pyyaml = "6.0.3"
+loguru = "0.7.2"
+python-gitlab = "8.4.0"
+rich = "15.0.0"
 oras = "0.2.42"
-idna = "3.15"
+idna = "3.18"
 requests = "2.34.2"
 behave = "^1.2.6"
 
@@ -47,7 +63,7 @@ gitlab-compliance = 'src.gitlab_compliance:gitlab_compliance'
 setuptools = "83.0.0"
 pytest = "^9.0.3"
 pre-commit = "^4.2.0"
-pyyaml = "^6.0.2"
+pyyaml = "^6.0.3"
 coverage = "^7.9.2"
 
 [tool.black]
@@ -61,7 +77,7 @@ max-line-length = 88
 extend-ignore = ["E203", "W503"]
 
 [tool.poetry.group.docs.dependencies]
-zensical = "^0.0.47"
+zensical = "^0.0.51"
 [build-system]
 requires = ["poetry-core","setuptools","poetry-bumpversion","id"]
 build-backend = "poetry.core.masonry.api"

gitlab_compliance-2.1.0/src/compliance/api_enrichment.py

@@ -0,0 +1,65 @@
+"""Detect which API-backed enrichment steps a policy pack requires."""
+
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+
+from src.compliance.metadata import iter_feature_files
+
+
+@dataclass
+class ApiEnrichmentRequirements:
+    enrich_includes: bool = False
+    enrich_images: bool = False
+    load_api_entities: bool = False
+
+
+INCLUDE_MARKERS = (
+    "include with release metadata",
+    "newer release",
+    "within the latest",
+)
+
+IMAGE_MARKERS = (
+    "container image with release metadata",
+    "registry latest",
+)
+
+API_ENTITY_MARKERS = (
+    "project setting",
+    "project ci variable",
+    "group setting",
+)
+
+
+def update_requirements_from_text(
+    text: str, reqs: ApiEnrichmentRequirements
+) -> ApiEnrichmentRequirements:
+    """Update enrichment requirements from one feature file's text."""
+    lowered = text.lower()
+    if not reqs.enrich_includes:
+        reqs.enrich_includes = any(marker in lowered for marker in INCLUDE_MARKERS)
+    if not reqs.enrich_images:
+        reqs.enrich_images = any(marker in lowered for marker in IMAGE_MARKERS)
+    if not reqs.load_api_entities:
+        reqs.load_api_entities = any(marker in lowered for marker in API_ENTITY_MARKERS)
+    return reqs
+
+
+def policies_require_api_enrichment(
+    features_dirs: str | list[str],
+) -> ApiEnrichmentRequirements:
+    reqs = ApiEnrichmentRequirements()
+    directories = [features_dirs] if isinstance(features_dirs, str) else features_dirs
+
+    for features_dir in directories:
+        if not os.path.isdir(features_dir):
+            continue
+        for feature_path in iter_feature_files(features_dir):
+            with open(feature_path, encoding="utf-8") as handle:
+                update_requirements_from_text(handle.read(), reqs)
+            if reqs.enrich_includes and reqs.enrich_images and reqs.load_api_entities:
+                return reqs
+
+    return reqs