Skip to content

CRken User Manual

⚠️ Note: This documentation section assumes that you (or your project maintainer or DevOps) have already integrated CRken into your GitLab project. If not, do it via Webhooks in your project's settings.

🚀 Getting started

CRken reviews code patches in Merge Requests and adds review notes as comments to the files. Once a new Merge Request is created or code in the existing Merge Request has been updated, GitLab triggers CRken to review the code patch in the Merge Request.

To see CRken in action, follow this simple steps:

  1. Let's assume that you already have a git branch named main and it contains some source code files. If not, just commit your code into the GitLab project's repository.
  2. Create a new branch, for example, develop.
  3. Under the develop branch, modify some source code files (or add new files) and push it to the repository.
  4. Open a new Merge Request with the develop branch as the source and main as the target.
  5. Navigate to the "Changes" tab and scroll to the file of your interest.

changes

📄 Conventions

  • CRken reviews code patches in Merge Requests only.
  • CRken adds review notes as comments to the files.
  • If the file already contains comments from CRken and has not been changed since the last review, CRken does not review the code patch for such file again.
  • If the file has been changed since the last review, CRken will delete or hide its outdated comment:
    • The outdated comment will be simply removed if there are no replies to CRken's comments.
    • The outdated comment will be folded if there are replies to CRken's comments.

▶️ Manual review initiation

You can initiate the review process manually by leaving comments on your Merge Request if Comments events has been enabled for the webhook. Comments that trigger the review must contain the special keyword /crken.

Review single file

Leave a comment on a specific file in your Merge Request to initiate the review of that file. In this case, any settings that define the target set of files will be ignored.

trigger the certain file

Review all target files

Leave a comment on the entire Merge Request to review all files targeted by the "target" parameters set.

⚠️ Note: Make sure your project maintainer, DevOps, or system administrator has configured the "target" in a proper way.

trigger all files