cicaddy-github 0.1.0__py3-none-any.whl

cicaddy_github-0.1.0.dist-info/METADATA

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: cicaddy-github
+Version: 0.1.0
+Summary: GitHub Actions plugin for cicaddy AI agent framework
+Project-URL: Homepage, https://github.com/redhat-community-ai-tools/cicaddy-action
+Project-URL: Repository, https://github.com/redhat-community-ai-tools/cicaddy-action.git
+Project-URL: Issues, https://github.com/redhat-community-ai-tools/cicaddy-action/issues
+Author: Wayne Sun
+License: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: cicaddy==0.3.0
+Requires-Dist: detect-secrets>=1.4.0
+Requires-Dist: pygithub>=2.1.0
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.23; extra == 'test'
+Requires-Dist: pytest-cov>=5.0; extra == 'test'
+Requires-Dist: pytest>=8.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# cicaddy-action
+
+GitHub Action that wraps [cicaddy](https://github.com/waynesun09/cicaddy) for running AI agent tasks in GitHub Actions workflows.
+
+## Features
+
+- **AI-powered PR reviews** with optional Context7 MCP for up-to-date library documentation
+- **Changelog report generation** from git tag diffs and release notes
+- **Multiple AI providers**: Gemini, OpenAI, Claude
+- **Secret redaction** via detect-secrets for safe public outputs
+- **DSPy YAML task definitions** for customizable analysis workflows
+
+## Quick Start
+
+### Changelog Report on Release
+
+```yaml
+name: Generate Changelog
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: redhat-community-ai-tools/cicaddy-action@v0
+        with:
+          ai_provider: gemini
+          ai_model: gemini-2.5-flash
+          ai_api_key: ${{ secrets.AI_API_KEY }}
+          task_file: tasks/changelog_report.yml
+```
+
+### AI PR Review
+
+```yaml
+name: PR Review
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  review:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: redhat-community-ai-tools/cicaddy-action@v0
+        with:
+          ai_provider: gemini
+          ai_model: gemini-3-flash-preview
+          ai_api_key: ${{ secrets.AI_API_KEY }}
+          task_file: tasks/pr_review.yml
+          post_pr_comment: 'true'
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Inputs
+
+| Input | Required | Description |
+|-------|----------|-------------|
+| `ai_provider` | Yes | AI provider: `gemini`, `openai`, `claude` |
+| `ai_model` | Yes | Model identifier |
+| `ai_api_key` | Yes | AI provider API key |
+| `task_file` | No | Path to DSPy YAML task file |
+| `task_prompt` | No | Inline task prompt (alternative to task_file) |
+| `report_template` | No | Path to custom HTML report template |
+| `mcp_servers_config` | No | JSON array of MCP server configs |
+| `slack_webhook_url` | No | Slack webhook URL for notifications |
+| `post_pr_comment` | No | Post results as PR comment (default: `false`) |
+| `github_token` | No | GitHub token (default: `${{ github.token }}`) |
+
+## Outputs
+
+| Output | Description |
+|--------|-------------|
+| `report_html` | Path to generated HTML report |
+| `report_json` | Path to JSON analysis result |
+| `summary` | Brief text summary |
+
+## Custom Tasks
+
+Create DSPy YAML task files to define custom analysis workflows. See `tasks/changelog_report.yml` and `tasks/pr_review.yml` for examples.
+
+## Local Development
+
+### Running cicaddy locally
+
+You can run cicaddy locally to review PRs without GitHub Actions. This is useful
+for testing changes to the plugin or reviewing PRs in other repositories.
+
+**1. Install the plugin in editable mode:**
+
+```bash
+uv pip install -e ".[test]"
+```
+
+**2. Create an env file** (e.g. `.env.my-review`):
+
+```bash
+# AI Provider
+AI_PROVIDER=gemini
+AI_MODEL=gemini-3-flash-preview
+GEMINI_API_KEY=<your-gemini-api-key>
+
+# GitHub Configuration
+GITHUB_TOKEN=<your-github-token>
+GITHUB_REPOSITORY=owner/repo
+GITHUB_EVENT_NAME=pull_request
+GITHUB_PR_NUMBER=42
+
+# Agent Settings
+POST_PR_COMMENT=true
+ENABLE_LOCAL_TOOLS=true
+LOCAL_TOOLS_WORKING_DIR=.
+
+# Optional: MCP servers (e.g. Context7 for library docs)
+MCP_SERVERS_CONFIG=[{"name": "context7", "protocol": "http", "endpoint": "https://mcp.context7.com/mcp", "headers": {"CONTEXT7_API_KEY": "<your-key>"}}]
+
+# Logging
+LOG_LEVEL=INFO
+```
+
+**3. Generate a GitHub token:**
+
+The token needs `repo` scope for private repos or `public_repo` for public repos.
+When `POST_PR_COMMENT=true`, the token must also have write access to pull requests
+(the `repo` scope includes this; for fine-grained tokens, enable "Pull requests: Write").
+
+```bash
+# Use your existing gh CLI token
+gh auth token
+```
+
+> **Warning:** Never commit env files containing secrets. The `.env.*` pattern is
+> already in `.gitignore`, but if you use a different naming convention (e.g. `.env`),
+> make sure it is also ignored.
+
+**4. Run the review:**
+
+```bash
+uv run cicaddy run --env-file .env.my-review
+```
+
+The agent auto-detects `github_pr` type from the env vars, fetches the PR diff,
+runs AI analysis, and optionally posts a comment on the PR.
+
+**5. Validate configuration** (optional):
+
+```bash
+uv run cicaddy validate --env-file .env.my-review
+```
+
+### Environment Variables Reference
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `AI_PROVIDER` | Yes | `gemini`, `openai`, or `claude` |
+| `AI_MODEL` | Yes | Model identifier (e.g. `gemini-3-flash-preview`) |
+| `GEMINI_API_KEY` / `OPENAI_API_KEY` / `ANTHROPIC_API_KEY` | Yes | API key matching the provider |
+| `GITHUB_TOKEN` | Yes | GitHub personal access token |
+| `GITHUB_REPOSITORY` | Yes | Target repo in `owner/repo` format |
+| `GITHUB_EVENT_NAME` | No | Set to `pull_request` for auto-detection (optional if `GITHUB_PR_NUMBER` is set) |
+| `GITHUB_PR_NUMBER` | Yes | PR number to review |
+| `POST_PR_COMMENT` | No | Post results as PR comment (`true`/`false`) |
+| `AI_TASK_FILE` | No | Path to DSPy YAML task file for custom workflows |
+| `GIT_DIFF_CONTEXT_LINES` | No | Number of context lines in diffs (default: `10`) |
+| `ENABLE_LOCAL_TOOLS` | No | Enable local git tools (`true`/`false`) |
+| `LOCAL_TOOLS_WORKING_DIR` | No | Working directory for local tools |
+| `MCP_SERVERS_CONFIG` | No | JSON array of MCP server configurations |
+| `LOG_LEVEL` | No | Logging level (`DEBUG`, `INFO`, `WARNING`, `ERROR`) |
+
+### Build & Test
+
+```bash
+# Run tests with coverage
+pytest tests/ -q --cov=src/cicaddy_github
+
+# Run all linters (pre-commit)
+pre-commit run --all-files
+
+# Build Docker image
+docker build -t cicaddy-action:test .
+```
+
+## License
+
+Apache-2.0

cicaddy_github-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+cicaddy_github/__init__.py,sha256=7uLKuiYduxF1vcz6P7ORCqhS9hwl4dtaZZCyhKETgZs,99
+cicaddy_github/plugin.py,sha256=GXcuKNpns9k2zsPQclb5KJmzNK13p9rTgjLsltB0Um8,3399
+cicaddy_github/validation.py,sha256=xHHz1pR79STNypGJEOpGRmDtaIU9x-nSf6zfdMKYF7c,688
+cicaddy_github/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cicaddy_github/config/settings.py,sha256=kzspVaRcn3659W11oEYIzXmehTr0fITvVfdpgsN2LvA,7222
+cicaddy_github/github_integration/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cicaddy_github/github_integration/agents.py,sha256=luTbqQ7-LpbIz6RQXTYYRpTsDVRn4YTwW_UkWWQ12Sk,10765
+cicaddy_github/github_integration/analyzer.py,sha256=uIdrP_gCR_UtvYYxtTiJkyAarPs7sKCflZMN0NHNriM,9680
+cicaddy_github/github_integration/detector.py,sha256=5RGplB88W5J9759MqD4cG_A420lJgqMCSvs6IGhwddk,709
+cicaddy_github/github_integration/tools.py,sha256=BYtff_V2FzSPG9mGGCpflxkPfD-GheLNjQ8arIMhKeM,4126
+cicaddy_github/security/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cicaddy_github/security/leak_detector.py,sha256=kkArkhByHLM0FvcDtppgycA4NGhWPaGiP8Jx1XPd3Ms,3740
+cicaddy_github-0.1.0.dist-info/METADATA,sha256=Qsq5FEbmWOnng0DgGBV7CNHSZtgIF3lEv-jiYWvxklE,6614
+cicaddy_github-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+cicaddy_github-0.1.0.dist-info/entry_points.txt,sha256=T6UUvXO-MP9QA-j32aaOV5DyEYK6zzLR_qZOydtZTog,335
+cicaddy_github-0.1.0.dist-info/licenses/LICENSE,sha256=wI-3LNTxmAXrtgXHKFqpGeQ8Yd0j5b4OnqqUh24Yebs,10764
+cicaddy_github-0.1.0.dist-info/RECORD,,

cicaddy_github-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

cicaddy_github-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,14 @@
+[cicaddy.agents]
+github = cicaddy_github.plugin:register_agents
+
+[cicaddy.cli_args]
+github = cicaddy_github.plugin:get_cli_args
+
+[cicaddy.env_vars]
+github = cicaddy_github.plugin:get_env_vars
+
+[cicaddy.settings_loader]
+github = cicaddy_github.config.settings:load_settings
+
+[cicaddy.validators]
+github = cicaddy_github.plugin:validate

cicaddy_github-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Red Hat, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.