You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25Lines changed: 25 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,31 @@ types, proper extends resolution, and a simple builder surface.
20
20
- Comprehensive test coverage (241 tests, 86%+ coverage)
21
21
- Small and dependency-light implementation
22
22
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
0 commit comments