Skip to content

Commit f5930bf

Browse files
committed
add readme file to replace missing config file comments
1 parent 057a499 commit f5930bf

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

.chloggen/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
### Changelog folder
2+
3+
This repo uses `chloggen` to manage its changelog files. You can find the source code for the tool [here](https://github.com/open-telemetry/opentelemetry-go-build-tools/tree/main/chloggen).
4+
5+
Here is a quick explanation of the `config.yaml` file for chloggen:
6+
7+
```yaml
8+
# The directory that stores individual changelog entries.
9+
# Each entry is stored in a dedicated yaml file.
10+
# - 'chloggen new' will copy the 'template_yaml' to this directory as a new entry file.
11+
# - 'chloggen validate' will validate that all entry files are valid.
12+
# - 'chloggen update' will read and delete all entry files in this directory, and update 'changelog_md'.
13+
# Specify as relative path from root of repo.
14+
# (Optional) Default: .chloggen
15+
entries_dir: .chloggen
16+
17+
# This file is used as the input for individual changelog entries.
18+
# Specify as relative path from root of repo.
19+
# (Optional) Default: .chloggen/TEMPLATE.yaml
20+
template_yaml: .chloggen/TEMPLATE.yaml
21+
22+
summary_template: .chloggen/summary.tmpl
23+
24+
# The CHANGELOG file or files to which 'chloggen update' will write new entries
25+
# (Optional) Default filename: CHANGELOG.md
26+
change_logs:
27+
user: CHANGELOG.md
28+
api: CHANGELOG-API.md
29+
30+
# The default change_log or change_logs to which an entry should be added.
31+
# If 'change_logs' is specified in this file, and no value is specified for 'default_change_logs',
32+
# then 'change_logs' MUST be specified in every entry file.
33+
default_change_logs: [user]
34+
```

0 commit comments

Comments
 (0)