open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

A few small documentation things around changelog generation. (#691) 

Co-authored-by: Armin Ruech <7052238+arminru@users.noreply.github.com>
This commit is contained in:
jason plumb 2024-02-06 02:10:36 -08:00 committed by GitHub
parent 5fd9bfeece
commit c9252a1222
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.chloggen/TEMPLATE.yaml
View File

@ -13,6 +13,7 @@ component:
note: note:
# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists.
# The values here must be integers.
issues: [] issues: []
# (Optional) One or more lines of additional information to render under the primary note. # (Optional) One or more lines of additional information to render under the primary note.

2
CONTRIBUTING.md
View File

@ -174,7 +174,7 @@ from `.yaml` files in the [/.chloggen](/.chloggen) directory.
Your pull request should add a new `.yaml` file to this directory. Your pull request should add a new `.yaml` file to this directory.
The name of your file can be arbitrary but must be unique since the last release. The name of your file can be arbitrary but must be unique since the last release.
During the release process, all `./chloggen/*.yaml` files are transcribed into During the release process, all `./.chloggen/*.yaml` files are transcribed into
`CHANGELOG.md` and then deleted. `CHANGELOG.md` and then deleted.
1. Create an entry file using `make chlog-new`. The command generates a new file, 1. Create an entry file using `make chlog-new`. The command generates a new file,