vrr/open-code-review
2
0
Fork 0
mirror of https://github.com/alibaba/open-code-review.git synced 2026-08-21 22:54:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
open-code-review/examples/codeup_ci
History
Exact
xujiejie d8fc4cd2af
Some checks are pending
CI / test (push) Waiting to run
Details
CI / windows (push) Waiting to run
Details
CI / cross-compile (amd64, darwin) (push) Waiting to run
Details
CI / cross-compile (amd64, windows) (push) Waiting to run
Details
CI / cross-compile (arm64, darwin) (push) Waiting to run
Details
Deploy Pages / deploy (push) Blocked by required conditions
Details
CI / cross-compile (arm64, linux) (push) Waiting to run
Details
CI / cross-compile (arm64, windows) (push) Waiting to run
Details
CodeQL Advanced / Analyze (go) (push) Waiting to run
Details
CodeQL Advanced / Analyze (actions) (push) Waiting to run
Details
CodeQL Advanced / Analyze (javascript-typescript) (push) Waiting to run
Details
Deploy Pages / build (push) Waiting to run
Details
chore(examples): add explicit --audience agent to codeup_ci and action.yml (#1004) 
Since PR #929 made 'human' the default audience and redirected [ocr] progress lines to stderr, the two non-interactive CI call sites that omitted --audience now emit progress noise on stderr. Add --audience agent to match the other four examples.

- examples/codeup_ci/post_review.py: add --audience agent to cmd
- action.yml: add --audience agent to ARGS (also covers github_actions)
- examples/codeup_ci/post_review_test.py: update exact cmd assertion

Exit-code handling, JSON parsing, and comment-posting logic are unchanged.

Closes #1003
2026-08-19 21:34:16 +08:00
..
codeup-flow.yml Add CodeUp CI integration (#570) 2026-07-29 22:37:29 +08:00
post_review.py chore(examples): add explicit --audience agent to codeup_ci and action.yml (#1004) 2026-08-19 21:34:16 +08:00
post_review_test.py chore(examples): add explicit --audience agent to codeup_ci and action.yml (#1004) 2026-08-19 21:34:16 +08:00
README.md Add CodeUp CI integration (#570) 2026-07-29 22:37:29 +08:00

README.md

CodeUp CI Integration

Run open-code-review (ocr) automatically on every merge request in Alibaba Cloud Yunxiao CodeUp, posting results as a merge request comment via Flow.

How it works

  1. A Yunxiao Flow pipeline is triggered on merge request open/update.
  2. The pipeline installs Node.js and the ocr CLI.
  3. post_review.py runs ocr review --format json against the diff between the merge request's target and source branches.
  4. Findings are formatted into a single Markdown summary and posted to the merge request via the CreateChangeRequestComment API.

This posts one summary comment per review run rather than true inline per-line comments. Inline comments require resolving the merge request's current patchset ID first — a reasonable follow-up, tracked as a known limitation below.

Setup

  1. Copy codeup-flow.yml into your repository (or paste its contents into a new pipeline in the Flow console) and adjust endpoint, serviceConnection, and runsOn for your organization.

  2. Copy post_review.py alongside it (or reference it directly if you keep it in a shared location).

  3. Configure the following pipeline variables in Flow, marking secrets as protected:

    Variable Required Description
    CODEUP_TOKEN Yes (secret) Personal access token used for the x-yunxiao-token header.
    CODEUP_ORG_ID Yes Your Yunxiao organization ID.
    CODEUP_REPO_ID Yes Numeric ID of the CodeUp repository.
    OCR_LLM_URL Yes Your LLM endpoint, e.g. https://api.anthropic.com/v1/messages.
    OCR_LLM_TOKEN Yes (secret) API key for the LLM endpoint.
    OCR_LLM_MODEL Yes Model name, e.g. <provider-model-name>.
    OCR_USE_ANTHROPIC If using Anthropic Set to true when OCR_LLM_URL is an Anthropic-compatible endpoint.

    CODEUP_MR_LOCAL_ID, CODEUP_TARGET_BRANCH, and CODEUP_SOURCE_BRANCH are populated automatically from the merge request trigger context — see codeup-flow.yml for how they're wired into the step's environment.

  4. Enable the merge-request trigger on the pipeline's code source (Edit pipeline → Edit code source → Enable code source trigger, with trigger event set to "Merge request created/updated").

Optional flags

Set OCR_REVIEW_EXTRA_ARGS as a pipeline variable to pass extra flags to ocr review, e.g. --concurrency 4.

Known limitations

  • Summary comment only. Findings are posted as one combined Markdown comment rather than individual inline comments anchored to specific lines. True inline comments would require calling CreateChangeRequestComment once per finding with file_path and line_number set against the merge request's current patchset — planned as a follow-up.
  • Requires a full (non-shallow) clone, or at minimum a fetch of the target branch, since post_review.py diffs origin/<target> against origin/<source>.

Local testing

python3 -m unittest post_review_test -v