-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathllms.txt
More file actions
29 lines (19 loc) · 1.53 KB
/
Copy pathllms.txt
File metadata and controls
29 lines (19 loc) · 1.53 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
# Chronicle
Chronicle is a fast changelog generator that sources changes from GitHub PRs and issues, organized by labels. It's a Go-based CLI tool developed by Anchore that helps automate the creation of changelogs for software releases.
## Project Structure
This is a Go project with the main package located in `cmd/chronicle/`. The core functionality is in the `chronicle/` directory with the following key components:
- **Release management**: `chronicle/release/` contains logic for parsing changes, formatting output, and managing releases
- **GitHub integration**: `chronicle/release/releasers/github/` handles GitHub API interactions for PRs, issues, and releases
- **Git operations**: `internal/git/` provides Git repository operations
- **CLI interface**: `cmd/chronicle/cli/` contains the command-line interface and commands
## Key Features
- Generates changelogs from GitHub PRs and issues based on labels
- Supports multiple output formats (markdown, JSON)
- Can guess next semantic version based on change types
- Configurable via YAML files
- Supports custom label-to-changelog-section mappings
- Can work with GitHub Enterprise deployments
## Configuration
Chronicle uses `.chronicle.yaml` configuration files and supports various options for customizing changelog generation, GitHub integration, logging, and semantic versioning behavior.
## Usage
The tool can generate changelogs between git tags, guess next versions, and format output in different ways. It's designed to integrate into CI/CD pipelines for automated release management.