Back to Vector

Single

website/layouts/releases/single.html

0.55.03.6 KB
Original Source

{{ define "title" }} {{ .Title }} | {{ site.Title }} {{ end }} {{ define "main" }} {{ $version := .File.BaseFileName }} {{ $release := index site.Data.docs.releases $version }} {{ $highlights := where (where site.RegularPages "Section" "highlights") ".Params.release" "eq" $version }} {{ $groups := dict "enhancement" "enhancements" "feat" "new features" "fix" "bug fixes" "deprecation" "deprecations" "chore" "chore"}} {{ $orderedGroups := slice "feat" "enhancement" "fix" "deprecation" "chore" }}

{{ partial "breadcrumb.html" . }}

{{ partial "hero.html" . }}

{{ with $release.codename }}

Code name {{ . }}

{{ end }} {{ with $highlights }} {{ range . }} {{ .Render "li" }} {{ end }} {{ end }} {{ with $release.description }} {{ . | markdownify }} {{ end }}

Upgrading Vector When upgrading, we recommend stepping through minor versions as these can each contain breaking changes while Vector is pre-1.0. These breaking changes are noted in their respective upgrade guides.

{{ with $release.known_issues }} {{ if gt (len $release.known_issues) 0 }}

{{ partial "heading.html" (dict "text" "Known issues" "level" 2) }}

{{ range . }} - {{ .| markdownify }} {{ end }}

{{ end }}

{{ end }} {{ if gt (len $release.changelog) 0 }}

{{ partial "heading.html" (dict "text" "Vector Changelog" "level" 2) }}

{{ range $orderedGroups }} {{ $key := . }} {{ $value := index $groups $key }} {{ $changes := where $release.changelog ".type" "eq" $key }} {{ if $changes }} {{ $numChanges := len $changes }} {{ $heading := printf "%d %s" $numChanges $value }}

{{ partial "heading.html" (dict "text" $heading "level" 3 "icon" false) }}

{{ range $changes }} - {{ .description | markdownify }} {{ if gt (len .contributors) 0 }}
Thanks to {{ $len := len .contributors }} {{ range $i, $contributor := .contributors }} {{ $contributor }}{{ if lt (add $i 1) $len }}, {{ end }} {{ end }} for contributing this change! {{ end }} {{ end }}

{{ end }} {{ end }}

{{ else }} {{ if gt (len $release.commits) 0 }}

{{ partial "heading.html" (dict "text" "Changelog" "level" 2) }}

{{ range $orderedGroups }} {{ $key := . }} {{ $value := index $groups $key }} {{ $commits := where $release.commits ".type" "eq" $key }} {{ if $commits }} {{ $numCommits := len $commits }} {{ $heading := printf "%d %s" $numCommits $value }}

{{ partial "heading.html" (dict "text" $heading "level" 3 "icon" false) }}

{{ range $commits }} {{ template "commit" . }} {{ end }}

{{ end }} {{ end }}

{{ end }} {{ end }} {{ with $release.vrl_changelog }} {{ if ne . "" }}

{{ partial "heading.html" (dict "text" "VRL Changelog" "level" 2) }}

{{ . | markdownify }}

{{ end }} {{ end }} {{ with $release.whats_next }} {{ partial "heading.html" (dict "text" "What's next" "level" 2) }} {{ range . }} {{ .title }} {{ .description | markdownify }}

{{ end }}

{{ end }}

{{ partial "heading.html" (dict "text" (print "Download Version " $version) "level" 2) }}

{{ partial "download/download-matrix.html" (dict "version" $version) }}

{{ end }} {{ define "changelog_entry" }} {{/* Description */}} {{ .description | markdownify }} {{ end }} {{ define "commit" }} {{/* Scopes */}} {{ range .scopes }} {{ partial "badge.html" (dict "word" . "color" "blue") }} {{ end }} {{/* Description */}} {{ .description | markdownify }} {{/* Pull request chip */}} {{ with .pr_number }} {{ $link := printf "https://github.com/vectordotdev/vector/pull/%v" . }} {{ . }} {{ end }} {{ end }} {{ define "below" }} {{ partial "releases/pagination.html" . }} {{ end }}