User Guide

Start here to install, configure, and use GPTChangelog effectively. The guides below cover everything from first-time setup to advanced workflows.

Contents

• Installation
• Learn how to install GPTChangelog and verify your setup.

• Go to the Installation guide: Installation

• Configuration

• Configure providers, GPT-5.6 profiles, explicit models, and authentication.

• Go to the Configuration guide: Configuration

• Basic Usage

• Generate your first changelog from Git commits and understand common options.

• Go to Basic Usage: Basic Usage

• Advanced Usage

• JSON output, CI/CD integration, validation, large ranges, and troubleshooting.

• Go to Advanced Usage: Advanced Usage

• Output contract

• Understand the strict model schema and deterministic release mechanics.
• Go to Output contract: Output contract

Tips for Best Results

• Follow Conventional Commits (feat:, fix:, docs:, refactor:, etc.) for clearer categorization.
• Tag your releases (e.g., v1.2.3) so version detection works consistently.
• Use --check in release automation before allowing a file update.
• Use --profile balanced for GPT-5.6 Terra or --profile quality for GPT-5.6 Sol.