Skip to content

Latest commit

 

History

History
59 lines (34 loc) · 1.84 KB

README.md

File metadata and controls

59 lines (34 loc) · 1.84 KB
Raw

CICD, Delivery, Compliance and Security Automation for Gardener

REUSE status

build

libs

security: bandit

What is it

cc-utils is a collection of re-usable utils intended to be used in the context of Continuous Integration and output qualification of components relevant for the gardener project.

End-User Documentation

How to contribute

Be sure to run tests, linter and codestyle checks:

  • .ci/lint
  • .ci/test

Run .ci/install_git_hooks to register recommended git hooks.

How to use it

Install using pip

pip install gardener-cicd-libs - install libraries (no CLI)

pip install gardener-cicd-cli - install CLI

Consume from Container Image

A copy of cc-utils is contained in the default container image in which gardener CI/CD jobs are run (europe-docker.pkg.dev/gardener-project/releases/cicd/job-image):

  • gardener-ci is available from PATH

Runtime environment requirements

Python Runtime

Python 3.11 or greater is required as a runtime (see requirements.txt for additional runtime dependencies).

As a general rule, contained sources are always qualified using the python3-version from alpine's greatest release version.

In addition to the Python API, some functions are exposed via a command line interface (./cli.py).

Special Modules

  • cli/gardener_ci/*.py: all defined functions are exposed via gardener-ci <module_name> <function_name>