pretty_release_notes/config.toml.example at main · barredterra/pretty_release_notes · GitHub

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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# Pretty Release Notes Configuration
# Copy this file to ~/.pretty-release-notes/config.toml and fill in your credentials

# Optional top-level settings
# Path to custom AI prompt template (default: "prompt.txt" in current directory)
# prompt_path = "prompt.txt"

# Force using commits even when PRs are available (default: false)
# force_use_commits = false

[github]
# GitHub personal access token (required)
# Create one at: https://github.com/settings/tokens
token = ""

# Default repository owner (optional)
# If not set, must be specified via --owner flag
owner = "frappe"

[llm]
# LLM provider API key (required)
# Use the API key for the provider referenced by `model`.
# Legacy [openai] is still accepted for backward compatibility.
api_key = ""

# Model to use. Prefer fully qualified "provider:model" values.
# Unqualified names still default to OpenAI for backward compatibility.
model = "openai:gpt-4.1"

# Optional reasoning effort override for supported models/providers.
# Supported values: "none", "low", "medium", "high", "xhigh"
# reasoning_effort = "medium"

# Maximum patch size before fallback to commit message (default: 10000)
max_patch_size = 10000

[database]
# Database type: "sqlite" or "csv" (default: "sqlite")
type = "sqlite"

# Database filename without extension (default: "stored_lines")
# Stored in ~/.pretty-release-notes/ directory
name = "stored_lines"

# Enable caching (default: true)
enabled = true

[filters]
# PR/commit types to exclude from release notes
exclude_change_types = ["chore", "refactor", "ci", "style", "test"]

# PR labels to exclude from release notes
exclude_change_labels = ["skip-release-notes"]

# Authors to exclude (typically bots)
exclude_authors = [
    "mergify[bot]",
    "copilot-pull-request-reviewer[bot]",
    "coderabbitai[bot]",
    "dependabot[bot]",
    "cursor[bot]"
]

[poll]
# Repositories to poll for new releases (used by `pretty-release-notes poll`)
# repos = ["frappe/erpnext", "frappe/frappe"]

[grouping]
# Enable grouping by conventional commit type (default: true)
group_by_type = true

# Customize section headings (optional)
# type_headings = { feat = "Features", fix = "Bug Fixes", perf = "Performance" }

# Heading for uncategorized changes (optional)
# other_heading = "Other Changes"