Git Release Steps

📘 Changelog & GitLab Release Process

Demo

Watch the video here

🔄 auto-changelog

We use auto-changelog to auto-generate changelogs based on Git commit history.

📥 Installation

npm install -g auto-changelog

🛠️ Generate Changelog

To update or create the CHANGELOG.md file with all commits from last preprod release (version x.y.z):

auto-changelog --commit-limit false

This command will:

• Read commit messages (based on semver tags) and compare with the last release version
• Update changelog history by writing directly to CHANGELOG.md

🚀 GitLab Release Tagging

When tagging a release in GitLab, we follow this structure in the Release Notes section.

📝 Format

### 📦 Environment
staging / pre-prod / production

### 🔗 Live URL
https://<your-app>.toolstation.nl

### 📋 Changelog
- Copy the relevant entries from `CHANGELOG.md`
- Only paste entries relevant to this release tag

✅ Checklist

• Create a release branch from target
• Make sure to update version in the nuxt.config
• Always generate changelog before tagging
• Tag format should be semantic: 1.2.3
• Preprod tag cannot contain rc hence must strictly follow semver (x.y.z)
• Preprod release title must be prefixed with "staging/" like staging/v1.2.3