GitLab Merge Requests

Promptless monitors your GitLab projects for merge requests. When a merge request is opened or updated, Promptless analyzes the changes and creates documentation suggestions if needed.

How It Works

When a merge request event occurs in your monitored GitLab projects:

1. Automatic Detection: Promptless receives notification of the new or updated merge request.
2. Analysis: The system processes the code diff, MR title, and MR description to understand the context.
3. Relevance Assessment: Promptless determines if the changes require documentation updates.
4. Suggestion Creation: If relevant, Promptless creates documentation suggestions.

Note

Information from merge requests is processed in real-time and not stored by Promptless. The analysis happens only when the configured trigger event occurs.

Configuration

Configure GitLab merge request triggers in your Configuration page using the triggers section:

triggers:
  gitlab-mrs:
    trigger_type: gitlab_mr
    match:
      - repos:
          - acme/backend
          - acme/api
        trigger_on:
          - opened
          - merge
        trigger_directories:
          - src/

See the Configuration Reference for all available options.

Directory-Specific Triggers

Use the trigger_directories field to only trigger when changes are made to specific directories. When specified, Promptless considers only merge requests that contain changes to those directories.

Automatic PR Creation

When automatic PR creation is enabled in your publishing policies, Promptless automatically creates a new PR in your documentation repository with suggested changes.

Source MR Comments

Promptless posts a summary comment on source merge requests linking to any documentation changes. This keeps documentation updates visible alongside the code changes that triggered them.

The comment links directly to the documentation suggestions, so reviewers can see proposed updates while reviewing the code.

Tip

Slack notifications are separate from source MR comments and are always sent according to your project’s notification settings.

Configuration Files and dot-Directories

Promptless automatically skips merge requests that only contain changes to dot-directories (like .gitlab/, .gitlab-ci/) or root-level dot-files (like .gitignore, .gitlab-ci.yml). These are typically CI and tooling configuration rather than product changes that need documentation updates.

If an MR contains both dot-files and regular source files, Promptless processes it normally—it only skips when the entire MR is dot-file changes.

Setup Instructions

To connect GitLab to Promptless, see the GitLab Integration setup guide.