cicaddy-gitlab 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Wayne Sun
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
@@ -0,0 +1,234 @@
1
+ Metadata-Version: 2.4
2
+ Name: cicaddy-gitlab
3
+ Version: 0.1.0
4
+ Summary: GitLab platform plugin for cicaddy AI agent
5
+ Author: Wayne Sun
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/redhat-community-ai-tools/cicaddy-gitlab
8
+ Project-URL: Documentation, https://github.com/redhat-community-ai-tools/cicaddy-gitlab/blob/main/docs/
9
+ Project-URL: Repository, https://github.com/redhat-community-ai-tools/cicaddy-gitlab.git
10
+ Project-URL: Issues, https://github.com/redhat-community-ai-tools/cicaddy-gitlab/issues
11
+ Keywords: ai,agent,mcp,pipeline,workflow,code-review,gitlab,automation
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Topic :: Software Development :: Quality Assurance
20
+ Classifier: Topic :: Security
21
+ Classifier: Topic :: Communications :: Chat
22
+ Requires-Python: >=3.11
23
+ Description-Content-Type: text/markdown
24
+ License-File: LICENSE
25
+ Requires-Dist: cicaddy>=0.2.0
26
+ Requires-Dist: python-gitlab>=4.4.0
27
+ Provides-Extra: dev
28
+ Requires-Dist: pytest>=8.4.0; extra == "dev"
29
+ Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
30
+ Requires-Dist: pytest-cov>=6.0.0; extra == "dev"
31
+ Requires-Dist: pytest-mock>=3.14.0; extra == "dev"
32
+ Requires-Dist: aioresponses>=0.7.8; extra == "dev"
33
+ Requires-Dist: ruff>=0.15.0; extra == "dev"
34
+ Requires-Dist: pre-commit>=4.0.0; extra == "dev"
35
+ Requires-Dist: build>=1.0.0; extra == "dev"
36
+ Requires-Dist: twine>=5.0.0; extra == "dev"
37
+ Provides-Extra: test
38
+ Requires-Dist: pytest>=8.4.0; extra == "test"
39
+ Requires-Dist: pytest-asyncio>=0.23.0; extra == "test"
40
+ Requires-Dist: pytest-cov>=6.0.0; extra == "test"
41
+ Requires-Dist: pytest-mock>=3.14.0; extra == "test"
42
+ Requires-Dist: aioresponses>=0.7.8; extra == "test"
43
+ Dynamic: license-file
44
+
45
+ # cicaddy-gitlab
46
+
47
+ GitLab platform plugin for the [cicaddy](https://github.com/waynesun09/cicaddy) AI agent framework.
48
+
49
+ ## Features
50
+
51
+ - **Merge Request Code Review** - AI-powered code review on GitLab merge requests with inline comments
52
+ - **Branch Review** - Compare branch changes against main for deployment readiness analysis
53
+ - **Scheduled Analysis** - Cron-based AI analysis jobs with MCP tool integration
54
+ - **Multi-Provider AI** - Support for Gemini, OpenAI, Claude
55
+ - **DSPy Task Files** - Declarative YAML prompt definitions for structured analysis
56
+ - **GitLab CI Templates** - Ready-to-use CI/CD templates for merge request and scheduled jobs
57
+
58
+ ## Installation
59
+
60
+ ```bash
61
+ pip install cicaddy-gitlab
62
+ ```
63
+
64
+ This automatically installs `cicaddy` core as a dependency and registers the GitLab plugin via entry points.
65
+
66
+ ## Quick Start
67
+
68
+ ### Merge Request Code Review
69
+
70
+ Add to your `.gitlab-ci.yml`:
71
+
72
+ ```yaml
73
+ include:
74
+ - remote: 'https://raw.githubusercontent.com/redhat-community-ai-tools/cicaddy-gitlab/main/gitlab/ai_agent_template.yml'
75
+
76
+ ai_code_review:
77
+ extends: .ai_agent_template
78
+ variables:
79
+ AI_PROVIDER: "gemini"
80
+ GEMINI_API_KEY: $GEMINI_API_KEY
81
+ SLACK_WEBHOOK_URL: $SLACK_WEBHOOK_URL
82
+ ```
83
+
84
+ ### Scheduled Analysis with MCP Tools
85
+
86
+ ```yaml
87
+ include:
88
+ - remote: 'https://raw.githubusercontent.com/redhat-community-ai-tools/cicaddy-gitlab/main/gitlab/ai_cron_template.yml'
89
+
90
+ daily_analysis:
91
+ extends: .ai_cron_template
92
+ variables:
93
+ AI_PROVIDER: "gemini"
94
+ GEMINI_API_KEY: $GEMINI_API_KEY
95
+ MCP_SERVERS_CONFIG: >-
96
+ [{"name": "my-server", "protocol": "http",
97
+ "endpoint": "https://my-mcp-server.example.com/mcp",
98
+ "timeout": 300, "idle_timeout": 60}]
99
+ AI_TASK_PROMPT: |
100
+ Use MCP tools to analyze data and generate a comprehensive report.
101
+ SLACK_WEBHOOK_URL: $SLACK_WEBHOOK_URL
102
+ rules:
103
+ - if: $CI_PIPELINE_SOURCE == "schedule"
104
+ ```
105
+
106
+ ### Using DSPy Task Files
107
+
108
+ Create structured task definitions in YAML:
109
+
110
+ ```yaml
111
+ # .gitlab/prompts/my_analysis.yml
112
+ name: custom_analysis
113
+ description: Custom analysis task
114
+ type: analysis
115
+ version: "1.0"
116
+
117
+ inputs:
118
+ - name: data_source
119
+ description: Data source to analyze
120
+ required: true
121
+
122
+ outputs:
123
+ - name: summary
124
+ description: Analysis summary
125
+ required: true
126
+ format: paragraph
127
+
128
+ constraints:
129
+ - Focus on actionable insights
130
+ - Prioritize by business impact
131
+
132
+ reasoning: chain_of_thought
133
+ output_format: markdown
134
+ ```
135
+
136
+ Reference it in your CI job:
137
+
138
+ ```yaml
139
+ custom_analysis:
140
+ extends: .ai_cron_template
141
+ variables:
142
+ AI_TASK_FILE: "../.gitlab/prompts/my_analysis.yml"
143
+ ```
144
+
145
+ ## CI Template Variables
146
+
147
+ ### Common Variables
148
+
149
+ | Variable | Default | Description |
150
+ |----------|---------|-------------|
151
+ | `AI_PROVIDER` | `gemini` | AI provider (gemini, openai, claude) |
152
+ | `AI_MODEL` | `gemini-3-flash-preview` | Model to use |
153
+ | `MCP_SERVERS_CONFIG` | `[]` | JSON array of MCP server configs |
154
+ | `AI_TASK_FILE` | (empty) | Path to DSPy task YAML file |
155
+ | `AI_TASK_PROMPT` | (built-in) | Inline task prompt |
156
+ | `SLACK_WEBHOOK_URL` | (empty) | Slack webhook for notifications |
157
+ | `MAX_INFER_ITERS` | `15` | Max AI inference iterations (agent: 15, cron: 30) |
158
+ | `LOG_LEVEL` | `INFO` | Logging verbosity |
159
+
160
+ ### Agent Template Variables
161
+
162
+ | Variable | Default | Description |
163
+ |----------|---------|-------------|
164
+ | `AGENT_TASKS` | `code_review` | Comma-separated task list |
165
+ | `GIT_DIFF_CONTEXT_LINES` | `10` | Context lines in diff |
166
+ | `GIT_WORKING_DIRECTORY` | `..` | Git repo directory |
167
+
168
+ ### Cron Template Variables
169
+
170
+ | Variable | Default | Description |
171
+ |----------|---------|-------------|
172
+ | `TASK_TYPE` | `custom` | Prompt template: `custom` (uses `AI_TASK_PROMPT`/`AI_TASK_FILE`), `security_audit`, `quality_report`, `dependency_check`; other values use general analysis |
173
+ | `TASK_SCOPE` | `external_tools` | Analysis scope |
174
+ | `MAX_EXECUTION_TIME` | `600` | Max execution time (seconds) |
175
+ | `CONTEXT_SAFETY_FACTOR` | `0.75` | Token budget safety factor |
176
+
177
+ ## Architecture
178
+
179
+ ```
180
+ cicaddy (core) - AI agent framework with MCP support
181
+ +-- cicaddy-gitlab - GitLab platform plugin (this package)
182
+ ```
183
+
184
+ The plugin registers with cicaddy via Python entry points:
185
+ - `cicaddy.agents` - MergeRequestAgent, BranchReviewAgent
186
+ - `cicaddy.settings_loader` - GitLab-specific settings
187
+ - `cicaddy.cli_args` - GitLab CLI arguments
188
+ - `cicaddy.validators` - GitLab configuration validation
189
+
190
+ ## Running Locally
191
+
192
+ You can run the agent outside of GitLab CI for development and testing using `.env` files.
193
+
194
+ ```bash
195
+ # Install from source
196
+ git clone https://github.com/redhat-community-ai-tools/cicaddy-gitlab.git
197
+ cd cicaddy-gitlab
198
+ uv pip install -e .
199
+
200
+ # Prepare environment file
201
+ cp .env.example .env.local
202
+ # Edit .env.local with your API key and settings
203
+
204
+ # Validate configuration
205
+ uv run cicaddy config show --env-file .env.local
206
+
207
+ # Run the agent
208
+ uv run cicaddy run --env-file .env.local
209
+
210
+ # Override settings via CLI
211
+ uv run cicaddy run --env-file .env.local --ai-provider openai --verbose
212
+ ```
213
+
214
+ For MR review, use `.env.mr.example` as a starting point — it includes GitLab API variables (`GITLAB_TOKEN`, `CI_MERGE_REQUEST_IID`, etc.).
215
+
216
+ See [docs/running-locally.md](docs/running-locally.md) for detailed examples including MCP server configuration, DSPy task files, and troubleshooting.
217
+
218
+ ## Development
219
+
220
+ ```bash
221
+ # Install with dev dependencies
222
+ uv pip install -e ".[dev]"
223
+
224
+ # Run tests
225
+ uv run pytest
226
+
227
+ # Lint and format
228
+ ruff check --fix src/ tests/
229
+ ruff format src/ tests/
230
+ ```
231
+
232
+ ## License
233
+
234
+ Apache License 2.0
@@ -0,0 +1,190 @@
1
+ # cicaddy-gitlab
2
+
3
+ GitLab platform plugin for the [cicaddy](https://github.com/waynesun09/cicaddy) AI agent framework.
4
+
5
+ ## Features
6
+
7
+ - **Merge Request Code Review** - AI-powered code review on GitLab merge requests with inline comments
8
+ - **Branch Review** - Compare branch changes against main for deployment readiness analysis
9
+ - **Scheduled Analysis** - Cron-based AI analysis jobs with MCP tool integration
10
+ - **Multi-Provider AI** - Support for Gemini, OpenAI, Claude
11
+ - **DSPy Task Files** - Declarative YAML prompt definitions for structured analysis
12
+ - **GitLab CI Templates** - Ready-to-use CI/CD templates for merge request and scheduled jobs
13
+
14
+ ## Installation
15
+
16
+ ```bash
17
+ pip install cicaddy-gitlab
18
+ ```
19
+
20
+ This automatically installs `cicaddy` core as a dependency and registers the GitLab plugin via entry points.
21
+
22
+ ## Quick Start
23
+
24
+ ### Merge Request Code Review
25
+
26
+ Add to your `.gitlab-ci.yml`:
27
+
28
+ ```yaml
29
+ include:
30
+ - remote: 'https://raw.githubusercontent.com/redhat-community-ai-tools/cicaddy-gitlab/main/gitlab/ai_agent_template.yml'
31
+
32
+ ai_code_review:
33
+ extends: .ai_agent_template
34
+ variables:
35
+ AI_PROVIDER: "gemini"
36
+ GEMINI_API_KEY: $GEMINI_API_KEY
37
+ SLACK_WEBHOOK_URL: $SLACK_WEBHOOK_URL
38
+ ```
39
+
40
+ ### Scheduled Analysis with MCP Tools
41
+
42
+ ```yaml
43
+ include:
44
+ - remote: 'https://raw.githubusercontent.com/redhat-community-ai-tools/cicaddy-gitlab/main/gitlab/ai_cron_template.yml'
45
+
46
+ daily_analysis:
47
+ extends: .ai_cron_template
48
+ variables:
49
+ AI_PROVIDER: "gemini"
50
+ GEMINI_API_KEY: $GEMINI_API_KEY
51
+ MCP_SERVERS_CONFIG: >-
52
+ [{"name": "my-server", "protocol": "http",
53
+ "endpoint": "https://my-mcp-server.example.com/mcp",
54
+ "timeout": 300, "idle_timeout": 60}]
55
+ AI_TASK_PROMPT: |
56
+ Use MCP tools to analyze data and generate a comprehensive report.
57
+ SLACK_WEBHOOK_URL: $SLACK_WEBHOOK_URL
58
+ rules:
59
+ - if: $CI_PIPELINE_SOURCE == "schedule"
60
+ ```
61
+
62
+ ### Using DSPy Task Files
63
+
64
+ Create structured task definitions in YAML:
65
+
66
+ ```yaml
67
+ # .gitlab/prompts/my_analysis.yml
68
+ name: custom_analysis
69
+ description: Custom analysis task
70
+ type: analysis
71
+ version: "1.0"
72
+
73
+ inputs:
74
+ - name: data_source
75
+ description: Data source to analyze
76
+ required: true
77
+
78
+ outputs:
79
+ - name: summary
80
+ description: Analysis summary
81
+ required: true
82
+ format: paragraph
83
+
84
+ constraints:
85
+ - Focus on actionable insights
86
+ - Prioritize by business impact
87
+
88
+ reasoning: chain_of_thought
89
+ output_format: markdown
90
+ ```
91
+
92
+ Reference it in your CI job:
93
+
94
+ ```yaml
95
+ custom_analysis:
96
+ extends: .ai_cron_template
97
+ variables:
98
+ AI_TASK_FILE: "../.gitlab/prompts/my_analysis.yml"
99
+ ```
100
+
101
+ ## CI Template Variables
102
+
103
+ ### Common Variables
104
+
105
+ | Variable | Default | Description |
106
+ |----------|---------|-------------|
107
+ | `AI_PROVIDER` | `gemini` | AI provider (gemini, openai, claude) |
108
+ | `AI_MODEL` | `gemini-3-flash-preview` | Model to use |
109
+ | `MCP_SERVERS_CONFIG` | `[]` | JSON array of MCP server configs |
110
+ | `AI_TASK_FILE` | (empty) | Path to DSPy task YAML file |
111
+ | `AI_TASK_PROMPT` | (built-in) | Inline task prompt |
112
+ | `SLACK_WEBHOOK_URL` | (empty) | Slack webhook for notifications |
113
+ | `MAX_INFER_ITERS` | `15` | Max AI inference iterations (agent: 15, cron: 30) |
114
+ | `LOG_LEVEL` | `INFO` | Logging verbosity |
115
+
116
+ ### Agent Template Variables
117
+
118
+ | Variable | Default | Description |
119
+ |----------|---------|-------------|
120
+ | `AGENT_TASKS` | `code_review` | Comma-separated task list |
121
+ | `GIT_DIFF_CONTEXT_LINES` | `10` | Context lines in diff |
122
+ | `GIT_WORKING_DIRECTORY` | `..` | Git repo directory |
123
+
124
+ ### Cron Template Variables
125
+
126
+ | Variable | Default | Description |
127
+ |----------|---------|-------------|
128
+ | `TASK_TYPE` | `custom` | Prompt template: `custom` (uses `AI_TASK_PROMPT`/`AI_TASK_FILE`), `security_audit`, `quality_report`, `dependency_check`; other values use general analysis |
129
+ | `TASK_SCOPE` | `external_tools` | Analysis scope |
130
+ | `MAX_EXECUTION_TIME` | `600` | Max execution time (seconds) |
131
+ | `CONTEXT_SAFETY_FACTOR` | `0.75` | Token budget safety factor |
132
+
133
+ ## Architecture
134
+
135
+ ```
136
+ cicaddy (core) - AI agent framework with MCP support
137
+ +-- cicaddy-gitlab - GitLab platform plugin (this package)
138
+ ```
139
+
140
+ The plugin registers with cicaddy via Python entry points:
141
+ - `cicaddy.agents` - MergeRequestAgent, BranchReviewAgent
142
+ - `cicaddy.settings_loader` - GitLab-specific settings
143
+ - `cicaddy.cli_args` - GitLab CLI arguments
144
+ - `cicaddy.validators` - GitLab configuration validation
145
+
146
+ ## Running Locally
147
+
148
+ You can run the agent outside of GitLab CI for development and testing using `.env` files.
149
+
150
+ ```bash
151
+ # Install from source
152
+ git clone https://github.com/redhat-community-ai-tools/cicaddy-gitlab.git
153
+ cd cicaddy-gitlab
154
+ uv pip install -e .
155
+
156
+ # Prepare environment file
157
+ cp .env.example .env.local
158
+ # Edit .env.local with your API key and settings
159
+
160
+ # Validate configuration
161
+ uv run cicaddy config show --env-file .env.local
162
+
163
+ # Run the agent
164
+ uv run cicaddy run --env-file .env.local
165
+
166
+ # Override settings via CLI
167
+ uv run cicaddy run --env-file .env.local --ai-provider openai --verbose
168
+ ```
169
+
170
+ For MR review, use `.env.mr.example` as a starting point — it includes GitLab API variables (`GITLAB_TOKEN`, `CI_MERGE_REQUEST_IID`, etc.).
171
+
172
+ See [docs/running-locally.md](docs/running-locally.md) for detailed examples including MCP server configuration, DSPy task files, and troubleshooting.
173
+
174
+ ## Development
175
+
176
+ ```bash
177
+ # Install with dev dependencies
178
+ uv pip install -e ".[dev]"
179
+
180
+ # Run tests
181
+ uv run pytest
182
+
183
+ # Lint and format
184
+ ruff check --fix src/ tests/
185
+ ruff format src/ tests/
186
+ ```
187
+
188
+ ## License
189
+
190
+ Apache License 2.0