Using in CI/CD¶
Run gitlab-compliance in your pipeline so policy violations fail before merge.
- GitLab CI/CD:
- Project-level jobs, shared templates, reports, rollout
- GitHub Actions:
- Workflows, Docker publish, pip vs container examples
- Pipeline Execution Policy:
- Org-wide injection via GitLab security policies
Typical compliance workflow:
- Copy or reference policies from
examples/example-policies/security/ - Add a compliance job (or inject one via Pipeline Execution Policy)
- Run
gitlab-compliance check -f policies/security/ -p .gitlab-ci.yml - Optionally pass
--projectfor API checks and--format codequalityfor GitLab reports - Fail the job on non-zero exit code
You can also publish pipeline documentation in CI with
generate:
gitlab-compliance generate -i .gitlab-ci.yml --format html -o public/index.html
Example policies: Examples. Sample generated docs: GitLab Docs output example.