mirror of
https://github.com/hanzoai/telemetry.git
synced 2026-10-30 20:01:49 +00:00
Moritz WiesingerandGitHub
bb4deb1ad3
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue. Ex. Adding a feature - Explain what this achieves.--> #### Description This PR adds some code to generate the list of allowed components for `chloggen`. All tooling was already prepared previously so we just need to make use of the features. The PR also adds a CI check to validate the component label in all changelog entries. <!-- Issue number if applicable --> #### Link to tracking issue Fixes #13923 <!--Describe the documentation added.--> #### Documentation I added a readme file as a replacement for the code comments in `.chloggen/config.yaml` since those are removed during auto generation of the file. <!--Please delete paragraphs that you did not use before submitting.-->
1.4 KiB
1.4 KiB
Changelog folder
This repo uses chloggen to manage its changelog files. You can find the source code for the tool here.
Here is a quick explanation of the config.yaml file for chloggen:
# The directory that stores individual changelog entries.
# Each entry is stored in a dedicated yaml file.
# - 'chloggen new' will copy the 'template_yaml' to this directory as a new entry file.
# - 'chloggen validate' will validate that all entry files are valid.
# - 'chloggen update' will read and delete all entry files in this directory, and update 'changelog_md'.
# Specify as relative path from root of repo.
# (Optional) Default: .chloggen
entries_dir: .chloggen
# This file is used as the input for individual changelog entries.
# Specify as relative path from root of repo.
# (Optional) Default: .chloggen/TEMPLATE.yaml
template_yaml: .chloggen/TEMPLATE.yaml
summary_template: .chloggen/summary.tmpl
# The CHANGELOG file or files to which 'chloggen update' will write new entries
# (Optional) Default filename: CHANGELOG.md
change_logs:
user: CHANGELOG.md
api: CHANGELOG-API.md
# The default change_log or change_logs to which an entry should be added.
# If 'change_logs' is specified in this file, and no value is specified for 'default_change_logs',
# then 'change_logs' MUST be specified in every entry file.
default_change_logs: [user]