-
Notifications
You must be signed in to change notification settings - Fork 6
feat: add pre-commit hooks, linting, and Claude Code setup #70
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pdettori
wants to merge
2
commits into
main
Choose a base branch
from
orchestrate/precommit
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "permissions": { | ||
| "allow": [ | ||
| "Bash(git status:*)", | ||
| "Bash(git log:*)", | ||
| "Bash(git diff:*)", | ||
| "Bash(git branch:*)", | ||
| "Bash(ls:*)", | ||
| "Bash(find:*)", | ||
| "Bash(make lint:*)", | ||
| "Bash(make fmt:*)", | ||
| "Bash(pre-commit run:*)", | ||
| "Bash(uv run pytest:*)", | ||
| "Bash(uv run ruff:*)" | ||
| ] | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| # plugins-adapter | ||
|
|
||
| ## Overview | ||
|
|
||
| An Envoy external processor (ext-proc) for configuring and invoking guardrails | ||
| in an Envoy-based gateway like [MCP Gateway](https://github.com/kagenti/mcp-gateway). | ||
| Intercepts gRPC traffic and applies configurable plugins (e.g., NeMo Guardrails). | ||
|
|
||
| ## Repository Structure | ||
|
|
||
| ``` | ||
| plugins-adapter/ | ||
| ├── src/ # Core server implementation (ext-proc gRPC server) | ||
| ├── plugins/ # Plugin implementations | ||
| │ └── examples/ # Example plugins (nemocheck, etc.) | ||
| ├── tests/ # Unit tests (pytest) | ||
| ├── docs/ # Architecture, build, deployment docs | ||
| ├── resources/ # Kubernetes manifests and config | ||
| ├── proto-build.sh # Protobuf code generation script | ||
| ├── ext-proc.yaml # Envoy ExtProc deployment manifest | ||
| └── filter.yaml # Envoy HTTP filter config | ||
| ``` | ||
|
|
||
| ## Key Commands | ||
|
|
||
| | Task | Command | | ||
| |------|---------| | ||
| | Lint + Format | `make lint` | | ||
| | Test | `uv run pytest tests/ -v` | | ||
| | Build image | `make build PLUGIN_DEPS=nemocheck` | | ||
| | Deploy to Kind | `make all PLUGIN_DEPS=nemocheck` | | ||
| | Build protobufs | `uv sync --group proto && ./proto-build.sh` | | ||
| | Run locally | `make dev-run-nemocheck` | | ||
|
|
||
| ## Code Style | ||
|
|
||
| - Python 3.11+ with `uv` package manager | ||
| - Linter/formatter: `ruff` (config in `pyproject.toml`) | ||
| - Pre-commit hooks: `pre-commit install` | ||
| - Sign-off required: `git commit -s` | ||
|
|
||
| ## Plugin Development | ||
|
|
||
| Plugins live in `plugins/`. Each plugin implements the `cpex` interface. | ||
| See `plugins/examples/` for reference implementations. | ||
|
|
||
| Config in `resources/config/config.yaml`: | ||
| ```yaml | ||
| plugins: | ||
| - name: my_plugin | ||
| path: ./plugins/my_plugin | ||
| enabled: true | ||
| ``` | ||
|
|
||
| ## DCO Sign-Off (Mandatory) | ||
|
|
||
| All commits must include a `Signed-off-by` trailer: | ||
|
|
||
| ```sh | ||
| git commit -s -m "feat: add feature" | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| #!/usr/bin/env bash | ||
| # commit-msg hook: enforce DCO sign-off and block Co-Authored-By AI attribution | ||
| set -euo pipefail | ||
|
|
||
| COMMIT_MSG_FILE="$1" | ||
| COMMIT_MSG=$(cat "$COMMIT_MSG_FILE") | ||
|
|
||
| # Check for DCO sign-off | ||
| if ! grep -qE "^Signed-off-by: .+ <.+@.+>" "$COMMIT_MSG_FILE"; then | ||
| echo "ERROR: Commit message missing Signed-off-by trailer (DCO required)." | ||
| echo " Use: git commit -s" | ||
| exit 1 | ||
| fi | ||
|
|
||
| # Block Co-Authored-By for AI (use Assisted-By instead) | ||
| if grep -qiE "^Co-[Aa]uthored-[Bb]y:.*claude|^Co-[Aa]uthored-[Bb]y:.*anthropic|^Co-[Aa]uthored-[Bb]y:.*openai|^Co-[Aa]uthored-[Bb]y:.*chatgpt" "$COMMIT_MSG_FILE"; then | ||
| echo "ERROR: Use 'Assisted-By' instead of 'Co-Authored-By' for AI attribution." | ||
| echo " Replace with: Assisted-By: Claude (Anthropic AI) <noreply@anthropic.com>" | ||
| exit 1 | ||
| fi | ||
|
|
||
| exit 0 |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: this one doesn't exist anymore