Skip to main content

OpenCSG-Starship App Install Guide

Introduction​

OpenCSG-Starship is an application available on the GitHub Marketplace that simplifies and enhances the Code Review process.

App Homepage: https://github.com/marketplace/opencsg-starship

Follow these steps to quickly install and configure the Starship App and start utilizing its Code Review features.

Steps to Use​

1. Install the Starship App​

  1. Visit the App Homepage
    Open the OpenCSG-Starship App Homepage.
    App Homepage Screenshot

  2. Install the App
    Click the "Install" button at the bottom of the homepage to start the installation.

  3. Configure GitHub Repositories
    After installation, go to the Starship Configuration Platform to set up the installed GitHub repositories for Code Review.

2. Sync GitHub Permissions​

  1. Log in to the Starship Configuration Platform
    Visit starship.opencsg.com and log in.

  2. Sync GitHub Permissions
    In the Settings page, click the "Sync GitHub Permissions" button:
    Sync GitHub Permissions Button Screenshot

  3. Complete Account Binding
    Once clicked, your GitHub account will be linked to the current Starship login user.

3. Add GitHub Projects​

  1. Click Add Project
    In the configuration platform, click the "Add Project" button:
    Add Project Button Screenshot

  2. Authorize OpenCSG-Starship App Installation
    The system will open the GitHub authorization page to install the Starship App. You can choose which GitHub Organization to install it on:
    Select Organization Screenshot

  3. Select Repository Scope
    After selecting an Organization, you can authorize all repositories or specific ones:
    Repository Authorization Screenshot

  4. Wait for Sync Completion
    After installation, the system will automatically sync the projects with the App installed and the user’s management permissions. This initialization process may take 1-5 minutes. Once completed, you will see the connected repositories listed in the Settings page:
    Connected Repositories Screenshot

4. Configure Code Review Rules​

  1. Go to Project Settings
    In the Settings page, select a connected repository.

  2. Start Code Review Configuration
    The current version of the Starship App focuses on Code Review functionality. You can customize the review rules based on your project needs:
    Code Review Feature Screenshot

Notes​

  • Initialization Time: After installing the App and syncing projects, the initialization may take 1-5 minutes. Please be patient.
  • Feature Scope: Currently, the Starship GitHub App supports only Code Review functionality. Additional features are under development.

By following these simple steps, you can start managing your Code Reviews efficiently with OpenCSG-Starship App!