Skip to main content

GCIP2

GCIP2 is a Python DSL for building GitLab CI/CD pipelines using strongly typed Pydantic models and a fluent builder API.

Instead of writing large YAML files, pipelines are defined in Python, validated against the official GitLab CI schema, and rendered into GitLab-compatible YAML.

Features

  • Strongly typed GitLab CI models
  • Fluent builder API
  • Reusable job builders
  • Pipeline inheritance
  • JSON Schema validation
  • Automatic YAML generation
  • Dynamic pipeline discovery
  • GitLab-compatible output

Installation

Create pyproject.toml with pyproject configuration

[project]
name = "dev"
version = "0.0.0"
description = ""
requires-python = ">=3.11,<4.0"

uv add gcip2

Quick Start

Initialize a new project:

dothat run init

This generates a minimal project structure:

.
├── ci.py
├── pyproject.toml
├── environment.toml
└── .pre-commit-config.yaml

Generate a child pipeline:

dothat run build-pipeline

or explicitly:

dothat run build-pipeline \
    --ci-file ci.py \
    --out-pipeline out/pipeline.gitlab-ci.yml

Generate the root .gitlab-ci.yml:

dothat run build-gitlab-ci

or

dothat run build-gitlab-ci \
    --ci-file ci.py \
    --out-gitlab-ci .gitlab-ci.yml

Documentation

Detailed documentation is available in the docs/ directory.

Document Description
docs/pipeline.md Creating pipelines, jobs and workflow configuration
docs/builder.md Pipeline builder, rendering and YAML generation
docs/pipeline_core.md Reference for the typed GitLab CI models
docs/secrets.md SecretsHandler with Vault integration
docs/project_config.md ProjectConfig with global environment
CHANGELOG.md Project changelog

Project Structure

A typical project consists of two builders:

ci.py
 ├── Pipeline(PipelineBuilderImpl)
 │      └── generates:
 │          out/pipeline.gitlab-ci.yml
 │
 └── GitlabCi(GitlabCiBuilderImpl)
        └── generates:
            .gitlab-ci.yml

Pipeline defines the reusable downstream pipeline, while GitlabCi defines the repository's root GitLab CI configuration.


CLI

Initialize a project:

dothat run init

Force regeneration of template files:

dothat run init --force

Build a child pipeline:

dothat run build-pipeline

Build the repository .gitlab-ci.yml:

dothat run build-gitlab-ci

Validation

Generated pipelines can be validated against the bundled GitLab JSON schema before rendering.


External Links


License

https://gl.pivlab.space/rnd/gcip2/-/blob/master/LICENCE.md

Release files for gcip2 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for gcip2 0.2.0
File Size Uploaded
gcip2-0.2.0.tar.gz 106.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for gcip2 0.2.0
File Interpreter ABI Platform
gcip2-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 167.0 kB

Release files / gcip2-0.2.0.tar.gz

Download URL gcip2-0.2.0.tar.gz
Size 106.0 kB
Tags Source
SHA-256 checksum
How to use checksums
56aad0b93deb99d326778fedfa17ebe3c17e86bb7dd6b16a853091a4d80117b1
BLAKE2b-256 checksum
How to use checksums
012134ecd42a0eee6ab4c64285e428386ff8d4fdedb8bc7e881487a03d000eed
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / gcip2-0.2.0-py3-none-any.whl

Download URL gcip2-0.2.0-py3-none-any.whl
Size 61.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2b7b2c5973cd6d661b7f8b48831e9350440a67be573ad1043b788fe763fa6bc4
BLAKE2b-256 checksum
How to use checksums
75d5fecfdac2868e1bbc73fbf2cb3c1b3dcf08248ad0e3ff36fb7e0977635bad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.9.30 {"installer":{"name":"uv","version":"0.9.30","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

This release

0.2.0 This release

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page