-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Use chloggen to generate changelog entries (#191)
- Loading branch information
1 parent
c67aa3d
commit fc88eaf
Showing
13 changed files
with
330 additions
and
105 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| # Use this changelog template to create an entry for release notes. | ||
|
|
||
| # One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' | ||
| change_type: | ||
|
|
||
| # The name of the component, or a single word describing the area of concern, (e.g. filelogreceiver) | ||
| component: | ||
|
|
||
| # A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). | ||
| note: | ||
|
|
||
| # Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. | ||
| issues: [] | ||
|
|
||
| # (Optional) One or more lines of additional information to render under the primary note. | ||
| # These lines will be padded with 2 spaces and then inserted directly into the document. | ||
| # Use pipe (|) for multiline entries. | ||
| subtext: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # The directory that stores individual changelog entries. | ||
| # Each entry is stored in a dedicated yaml file. | ||
| # - 'make chlog-new' will copy the 'template_yaml' to this directory as a new entry file. | ||
| # - 'make chlog-validate' will validate that all entry files are valid. | ||
| # - 'make chlog-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 | ||
|
|
||
| # 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] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| {{- define "entry" -}} | ||
| - `{{ .Component }}`: {{ .Note }} ( | ||
| {{- range $i, $issue := .Issues }} | ||
| {{- if $i }}, {{ end -}} | ||
| #{{ $issue }} | ||
| {{- end -}} | ||
| ) | ||
|
|
||
| {{- if .SubText }} | ||
| {{ .SubText | indent 2 }} | ||
| {{- end }} | ||
| {{- end }} | ||
| ## {{ .Version }} | ||
|
|
||
| This release includes version XX.YY.ZZ of the upstream Collector components. | ||
|
|
||
| The individual changelogs can be found here: | ||
|
|
||
| vXX.YY.ZZ: | ||
| https://github.com/open-telemetry/opentelemetry-collector/releases/tag/vXX.YY.ZZ | ||
| https://github.com/open-telemetry/opentelemetry-collector-contrib/releases/tag/vXX.YY.ZZ | ||
|
|
||
| <details> | ||
| <summary>Highlights from the above changelog</summary> | ||
|
|
||
| - | ||
|
|
||
| </details> | ||
|
|
||
| {{- if .BreakingChanges }} | ||
|
|
||
| ### Breaking changes | ||
|
|
||
| {{- range $i, $change := .BreakingChanges }} | ||
| {{- if eq $i 0}} | ||
| {{end}} | ||
| {{ template "entry" $change }} | ||
| {{- end }} | ||
| {{- end }} | ||
|
|
||
| {{- if .Deprecations }} | ||
|
|
||
| ### Deprecations | ||
|
|
||
| {{- range $i, $change := .Deprecations }} | ||
| {{- if eq $i 0}} | ||
| {{end}} | ||
| {{ template "entry" $change }} | ||
| {{- end }} | ||
| {{- end }} | ||
|
|
||
| {{- if .NewComponents }} | ||
|
|
||
| ### New components | ||
|
|
||
| {{- range $i, $change := .NewComponents }} | ||
| {{- if eq $i 0}} | ||
| {{end}} | ||
| {{ template "entry" $change }} | ||
| {{- end }} | ||
| {{- end }} | ||
|
|
||
| {{- if .Enhancements }} | ||
|
|
||
| ### Enhancements | ||
|
|
||
| {{- range $i, $change := .Enhancements }} | ||
| {{- if eq $i 0}} | ||
| {{end}} | ||
| {{ template "entry" $change }} | ||
| {{- end }} | ||
| {{- end }} | ||
|
|
||
| {{- if .BugFixes }} | ||
|
|
||
| ### Bug fixes | ||
|
|
||
| {{- range $i, $change := .BugFixes }} | ||
| {{- if eq $i 0}} | ||
| {{end}} | ||
| {{ template "entry" $change }} | ||
| {{- end }} | ||
| {{- end }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| # This action requires that any PR targeting the main branch should touch at | ||
| # least one CHANGELOG file. If a CHANGELOG entry is not required, add the "Skip | ||
| # Changelog" label to disable this action. | ||
|
|
||
| name: 'Changelog' | ||
|
|
||
| on: | ||
| pull_request: | ||
| types: [opened, ready_for_review, synchronize, reopened, labeled, unlabeled] | ||
| branches: | ||
| - main | ||
|
|
||
| concurrency: | ||
| group: ${{ github.workflow }}-${{ github.head_ref }} | ||
| cancel-in-progress: true | ||
|
|
||
| jobs: | ||
| changelog: | ||
| runs-on: ubuntu-latest | ||
| if: >- | ||
| ${{ | ||
| !contains(github.event.pull_request.labels.*.name, 'dependencies') && | ||
| !contains(github.event.pull_request.labels.*.name, 'Skip Changelog') && | ||
| !contains(github.event.pull_request.title, '[chore]') | ||
| }} | ||
| env: | ||
| PR_HEAD: ${{ github.event.pull_request.head.sha }} | ||
| steps: | ||
| - name: Checkout Repo | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| - name: Setup Go | ||
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: ~1.21.6 | ||
| - name: Cache Go | ||
| id: go-cache | ||
| uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ~/go/bin | ||
| ~/go/pkg/mod | ||
| key: changelog-${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} | ||
|
|
||
| - name: Ensure no changes to the CHANGELOG.md | ||
| run: | | ||
| if [[ $(git diff --name-only $(git merge-base origin/main $PR_HEAD) $PR_HEAD ./CHANGELOG*.md) ]] | ||
| then | ||
| echo "CHANGELOG.md should not be directly modified." | ||
| echo "Please add a .yaml file to the ./.chloggen/ directory." | ||
| echo "See CONTRIBUTING.md for more details." | ||
| echo "Alternately, add either \"[chore]\" to the title of the pull \ request or add the \"Skip Changelog\" label if this job should be skipped." | ||
| false | ||
| else | ||
| echo "CHANGELOG.md was not modified." | ||
| fi | ||
| - name: Ensure ./.chloggen/*.yaml addition(s) | ||
| run: | | ||
| if [[ 1 -gt $(git diff --diff-filter=A --name-only $(git merge-base origin/main $PR_HEAD) $PR_HEAD ./.chloggen | grep -c \\.yaml) ]] | ||
| then | ||
| echo "No changelog entry was added to the ./.chloggen/ directory." | ||
| echo "Please add a .yaml file to the ./.chloggen/ directory." | ||
| echo "See CONTRIBUTING.md for more details." | ||
| echo "Alternately, add either \"[chore]\" to the title of the pull request or add the \"Skip Changelog\" label if this job should be skipped." | ||
| false | ||
| else | ||
| echo "A changelog entry was added to the ./.chloggen/ directory." | ||
| fi | ||
| - name: Validate ./.chloggen/*.yaml changes | ||
| run: | | ||
| make chlog-validate \ | ||
| || { echo "New ./.chloggen/*.yaml file failed validation."; exit 1; } | ||
| # In order to validate any links in the yaml file, render the config to markdown | ||
| - name: Render .chloggen changelog entries | ||
| run: make chlog-preview > changelog_preview.md | ||
| - name: Install markdown-link-check | ||
| run: npm install -g markdown-link-check | ||
| - name: Run markdown-link-check | ||
| run: | | ||
| markdown-link-check \ | ||
| --verbose \ | ||
| --config .markdown_link_check_config.json \ | ||
| changelog_preview.md \ | ||
| || { echo "Check that anchor links are lowercase"; exit 1; } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <!-- This file is autogenerated. See CONTRIBUTING.md for instructions to add an entry. --> | ||
|
|
||
| # Changelog | ||
|
|
||
| <!-- next version --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.