open-code-review/examples/gitflic_ci/gitflic-ci.yaml at main · alibaba/open-code-review · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
# OpenCodeReview - GitFlic CI Merge Request Auto-Review Demo
#
# Reviews Merge Requests with OpenCodeReview and posts the findings onto the
# MR as discussions (inline where possible). The posting glue lives in the CI
# layer, in post_review.py next to this file -- consistent with the GitHub and
# GitLab examples, which keep platform-specific publishing out of the `ocr`
# binary.
#
# Setup:
#   - Commit BOTH this file and post_review.py into your repository (adjust the
#     `python3 post_review.py` path below if you place the script elsewhere).
#   - Enable "Merge Request Pipeline" in Project Settings -> CI/CD Settings.
#   - Use a runner able to run the node:20 image (it ships node, python3 and git),
#     or any shell runner with node 20+, python3 and git available.
#
# Required CI/CD Variables (Settings -> CI/CD -> Variables):
#   OCR_LLM_URL        - LLM API endpoint (e.g., https://api.openai.com/v1/chat/completions)
#   OCR_LLM_AUTH_TOKEN - Authentication token for the LLM API
#   GITFLIC_TOKEN      - GitFlic access token used to post MR discussions
#
# Optional CI/CD Variables:
#   OCR_LLM_MODEL      - Model name (e.g., gpt-4o)
#   GITFLIC_API_URL    - GitFlic REST API base URL; only needed for self-hosted
#                        instances (defaults to https://api.gitflic.ru)
#
# post_review.py picks up the MR context automatically from the predefined
# GitFlic CI variables: CI_PROJECT_NAMESPACE, CI_PROJECT_NAME,
# CI_MERGE_REQUEST_LOCAL_ID, CI_MERGE_REQUEST_TARGET_BRANCH_NAME, CI_COMMIT_SHA.

stages:
  - review

code-review:
  stage: review
  image: node:20
  script:
    # Run only in merge request pipelines
    - |
      if [ -z "$CI_MERGE_REQUEST_LOCAL_ID" ]; then
        echo "Not a merge request pipeline, skipping review."
        exit 0
      fi

    # Install OpenCodeReview
    - npm install -g @alibaba-group/open-code-review

    # Configure OCR
    - |
      ocr config set llm.url $OCR_LLM_URL
      ocr config set llm.auth_token $OCR_LLM_AUTH_TOKEN
      if [ -n "$OCR_LLM_MODEL" ]; then
        ocr config set llm.model "$OCR_LLM_MODEL"
      fi
      ocr config set llm.use_anthropic false
      ocr config set llm.extra_body '{"thinking": {"type": "disabled"}}'

    # Make sure the target branch and full history are available for merge-base diff
    - git fetch --unshallow 2>/dev/null || true
    - git fetch origin "$CI_MERGE_REQUEST_TARGET_BRANCH_NAME"

    # Run OCR review (CI_COMMIT_SHA as head supports forked MRs as well)
    - |
      ocr review \
        --from "origin/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME}" \
        --to "${CI_COMMIT_SHA}" \
        --format json \
        --audience agent \
        > /tmp/ocr-result.json || true
      echo "OCR review completed."

    # Post review comments onto the MR (inline discussions + summary note).
    # post_review.py recomputes the old-side line for each comment from the
    # merge-base diff, which the GitFlic Discussions API requires for inline
    # (code) comments.
    #
    # The review step above ends with `|| true`, so a failed `ocr review` (bad
    # token, network error) leaves an empty or partial file. Skip posting in
    # that case instead of feeding invalid JSON to post_review.py.
    - |
      if [ ! -s /tmp/ocr-result.json ]; then
        echo "OCR review produced no output, skipping post."
        exit 0
      fi
      python3 post_review.py /tmp/ocr-result.json