Skip to main content

Installation

The StarShip CodeReviewer, a crucial import module of the StarShip suite, comes pre-integrated and is installed along with the primary StarShip package.

The usage and configuration are very straightforward. We need to import project repositories from a code hosting system (using GitLab as an example below) into StarShip and grant it the necessary permissions (repository read access and API authorization of the relevant code hosting system).

This allows StarShip to receive events related to merge requests/pull requests and trigger the corresponding CodeReview tasks. After execution, StarShip will utilize the user's authorized API permissions to insert the review results into the merge requests/pull requests as comments for users.

Additionally, users can provide feedback on the comments, which will reach StarShip's CodeReview Chat Copilot. This enables further user feedback requests, allowing for even more in-depth CodeReview results.

Below is the GitLab configuration interface: alt text

Users can enter the URL of a specific GitLab instance along with the corresponding Access Token. Next, by clicking "Create New Project" and entering the project name, the system will search for the relevant project. Once selected and saved, StarShip will automatically configure the webhook in the corresponding GitLab project, allowing users to continue using the system seamlessly. alt text alt text