Skip to content

Commit ac8da01

Browse files
committed
Add "Limitations" section to README
1 parent 515bff0 commit ac8da01

File tree

2 files changed

+30
-0
lines changed

2 files changed

+30
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@noxify/gitlab-ci-builder": patch
3+
---
4+
5+
Add "Limitations" section to README

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,31 @@ types, proper extends resolution, and a simple builder surface.
2020
- Comprehensive test coverage (241 tests, 86%+ coverage)
2121
- Small and dependency-light implementation
2222

23+
## Limitations
24+
25+
This builder focuses on **composing and generating** GitLab CI configurations programmatically. It is **not** a replacement for GitLab's CI/CD execution engine. Here's what it **cannot** do:
26+
27+
- **Execute pipelines**: This library generates YAML configurations; it does not run jobs, scripts, or pipelines
28+
- **Validate GitLab-specific runtime behavior**: While it validates schema structure, it cannot check runtime requirements like Docker availability, GitLab Runner setup, or environment-specific constraints
29+
- **Access GitLab API for live data**: The library works with static configuration files and does not interact with GitLab's API to fetch live pipeline status, variables, or runner information
30+
- **Resolve complex variable interpolations**: GitLab CI supports advanced variable expansion and substitution at runtime; this builder only handles static variable definitions
31+
- **Handle all YAML edge cases**: While it supports most GitLab CI features, some advanced YAML constructs or GitLab-specific behaviors might not be fully supported
32+
- **Replace GitLab CI/CD**: This is a development tool for building configurations, not an alternative CI/CD platform
33+
34+
**Use this library when you want to:**
35+
36+
- Generate GitLab CI YAML programmatically with TypeScript
37+
- Maintain large, complex pipeline configurations with code reuse
38+
- Visualize and document pipeline structures
39+
- Convert between YAML and TypeScript representations
40+
- Validate configuration structure before committing
41+
42+
**Do not use this library when you need to:**
43+
44+
- Execute actual CI/CD pipelines (use GitLab CI/CD for that)
45+
- Interact with GitLab's runtime environment or API
46+
- Validate runtime-specific requirements
47+
2348
## Installation
2449

2550
```bash

0 commit comments

Comments
 (0)