1.0.0 • Published 5 months ago

gitlab-mr-assistant v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

GitLab Merge Request Assistant

Prerequisites

  • Node.js (v16+)
  • GitLab Personal Access Token
  • Gemini API Key

Installation

Global Installation (Recommended for CI/CD)

npm install -g gitlab-mr-assistant

Local Development Setup

  1. Clone the repository
  2. Install dependencies:
    npm install
  3. Create a .env file with your configurations:
    GITLAB_TOKEN=your_gitlab_token
    GITLAB_API_URL=https://gitlab.com/api/v4
    GITLAB_PROJECT_ID=your_project_id
    GOOGLE_API_KEY=your_google_api_key

Usage

Command Line

After global installation:

gitlab-mr-assistant summarize <merge_request_iid>

In GitLab CI/CD Pipeline

Add to .gitlab-ci.yml:

review-mr:
  stage: review
  before_script:
    - npm install -g gitlab-mr-assistant
  script:
    - export GITLAB_TOKEN=${GITLAB_TOKEN}
    - export GEMINI_API_KEY=${GEMINI_API_KEY}
    - export GITLAB_PROJECT_ID=${CI_PROJECT_ID}
    - gitlab-mr-assistant summarize $CI_MERGE_REQUEST_IID
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
  when: manual

Make sure to set GITLAB_TOKEN and GEMINI_API_KEY as CI/CD variables in your GitLab project settings.

Commands

  • summarize <merge_request_iid>: Generate AI summary of merge request changes