Skip to content

Commit

Permalink
Include PR/Issue links in the changelog (#1630)
Browse files Browse the repository at this point in the history
  • Loading branch information
joaopgrassi authored Dec 3, 2024
1 parent 123dd93 commit 2d34907
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .chloggen/CHANGELOG.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
{{/*
Based on the default template:
https://github.com/open-telemetry/opentelemetry-go-build-tools/blob/v0.15.0/chloggen/internal/chlog/summary.tmpl
*/}}
{{- define "entry" -}}
- `{{ .Component }}`: {{ .Note }} (
{{- range $i, $issue := .Issues }}
{{- if $i }}, {{ end -}}
[#{{ $issue }}](https://github.com/open-telemetry/semantic-conventions/issues/{{ $issue }})
{{- end -}}
)

{{- if .SubText }}
{{ .SubText | indent 2 }}
{{- end }}
{{- end }}
## {{ .Version }}

{{- 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 }}
3 changes: 3 additions & 0 deletions .chloggen/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ change_logs:
# 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]

# Custom template for the changelog that include links for the issue/PRs
summary_template: .chloggen/CHANGELOG.tmpl

0 comments on commit 2d34907

Please sign in to comment.