隨記

Rationale

GitLab maintains a changelog for every release. User-facing changes must be documented so users understand what changed and how it affects them.

Requirements

  1. All user-facing changes must include a changelog entry
  2. Entry format: - [Category] Description (!merge_request_id)
  3. Categories: Added, Changed, Deprecated, Removed, Fixed, Security
  4. Changelog must be in the Merge Request description

Changelog Entry Format

## Changelog

- [Added] New API endpoint for batch user import (!12345)
- [Fixed] Memory leak in background job processing (!12346)
- [Security] Updated dependency to fix CVE-2024-XXXXX (!12347)

What Requires Changelog

  • New features or endpoints
  • Bug fixes affecting users
  • Breaking changes
  • Deprecations
  • Security patches

What Does NOT Require Changelog

  • Internal refactoring
  • Test additions
  • Documentation updates
  • CI/CD changes

References