Skip to main content

Unofficial GitLab CI integration layer for Open Code Review

Project description

Open Code Review Toolkit

Open Code Review Toolkit is an unofficial GitLab CI integration layer for Alibaba Open Code Review. It provides bounded repository context generation, environment-driven OCR configuration, preflight validation, and safe GitLab merge-request posting. It does not bundle or download the ocr binary.

[!NOTE] The project is under active development. It currently targets Python 3.10-3.14 on Linux and macOS; the public API, CLI, environment contract, and generated schemas may evolve before 1.0.

Install

Install the Python package from PyPI and install a supported OCR binary separately:

python -m pip install open-code-review-toolkit
ocr --version
ocr-ci --help

The current compatibility target is OCR 1.7.13. CI should pin the release and verify its published checksum before execution. Review output defaults to English. Set OCR_REVIEW_LANGUAGE=Russian to use Russian consistently in both OCR configuration and generated review context.

Stable distributions are published to PyPI and mirrored as checksum-listed, provenance-attested assets in the corresponding GitHub Release. Development snapshots are published only to TestPyPI.

GitLab CI quick start

  1. Configure protected/masked GITLAB_API_TOKEN and LLM variables in GitLab.
  2. Pin and checksum the OCR binary.
  3. Install this package.
  4. Run the five helper stages around ocr review:
ocr-ci preflight
ocr-ci configure
ocr-ci mcp-config
ocr-ci context --output .review-context/dependencies.md
# run: ocr review ... --format json
ocr-ci post --result /tmp/ocr-result.json --stderr /tmp/ocr-stderr.log

See the fully synthetic examples/gitlab/ocr-review.gitlab-ci.yml and the GitLab guide.

Configuration and safety

Configuration is environment-only in v0.1. The configuration reference documents supported OCR_*, CI_*, GITLAB_*, and MCP inputs. Posting requires GITLAB_API_TOKEN; job tokens and legacy aliases are deliberately unsupported.

Repository content, OCR output, and provider responses are untrusted inputs. The toolkit applies bounded reads and writes, secret redaction, Unicode normalization, Markdown/quick-action neutralization, fingerprinted comments, ownership boundaries for human replies, and rollback controls. Review the security and trust model before enabling write access.

Development and release

Licensed under Apache-2.0.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

open_code_review_toolkit-0.1.0.tar.gz (122.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

open_code_review_toolkit-0.1.0-py3-none-any.whl (96.8 kB view details)

Uploaded Python 3

File details

Details for the file open_code_review_toolkit-0.1.0.tar.gz.

File metadata

  • Download URL: open_code_review_toolkit-0.1.0.tar.gz
  • Upload date:
  • Size: 122.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for open_code_review_toolkit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 34400866886ba253f933315332c439679da30a9612b0deb4e1bb73de44438ce9
MD5 6da99c3ae73c53773e32aadb438c8aea
BLAKE2b-256 cb35b7e5c14aa744433a04381ba6d156aac279b2ea42f8a14ca92ab4d46c13b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_code_review_toolkit-0.1.0.tar.gz:

Publisher: release.yml on xeonvs/open-code-review-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file open_code_review_toolkit-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for open_code_review_toolkit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ad2ddac2fe39bc204a1ea5f80340a126faee96797de97e8505c18b2acb7d6016
MD5 908067996730c6b5ba24124f8a6c8357
BLAKE2b-256 243c93f185bb871a25e72b8b3564d2309b7d0a61cef4f352bd086a30ac84a4d4

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_code_review_toolkit-0.1.0-py3-none-any.whl:

Publisher: release.yml on xeonvs/open-code-review-toolkit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page