Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into pc-11970-fix-errors-h…
Browse files Browse the repository at this point in the history
…andling-diags
  • Loading branch information
nieomylnieja committed Feb 14, 2024
2 parents ea34ef3 + 3a405ed commit a3f8bce
Show file tree
Hide file tree
Showing 55 changed files with 1,402 additions and 498 deletions.
29 changes: 29 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Motivation

Describe what is the motivation behind the proposed changes.
If possible reference the current solution/state of affairs.

## Summary

Recap of changed code.

## Related Changes

List related changes from other PRs (if any).

## Testing

- Describe how to check introduced code changes manually.
- Take care of test coverage on unit, integration or end-to-end levels.

## Release Notes

If this change should be part of the Release Notes,
**replace this entire paragraph** with 1-3 sentences about the changes.
Otherwise, you **MUST** remove this section entirely.

## Breaking Changes

Does this PR contain any breaking changes?
If so **replace this entire paragraph** with a description of these changes.
Otherwise, you **MUST** remove this section entirely.
94 changes: 94 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
name-template: "v$RESOLVED_VERSION"
tag-template: "v$RESOLVED_VERSION"
categories:
- title: ⚠️ Breaking Changes
labels:
- breaking-change
- title: 🚀 Features
labels:
- enhancement
- title: 💻 Fixed Vulnerabilities
labels:
- security
- title: 🐞 Bug Fixes
labels:
- bug
- title: 🧰 Maintenance
collapse-after: 3
labels:
- chore
- infrastructure
- title: 🤖 Dependency Updates
collapse-after: 3
labels:
- dependencies
change-template: "- $TITLE (#$NUMBER) @$AUTHOR"
change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
version-resolver:
major:
labels:
- major
minor:
labels:
- minor
patch:
labels:
- patch
default: patch
autolabeler:
# Pull requests scope.
- label: enhancement
title:
- "/^feat:/i"
- label: chore
title:
- "/^chore:/i"
- label: infrastructure
title:
- "/^infra:/i"
- label: security
title:
- "/^sec:/i"
- label: bug
title:
- "/^fix:/i"
- label: documentation
title:
- "/^doc:/i"
- label: breaking-change
body:
- '/^## Breaking Changes/im'
- label: release-notes
body:
- '/^## Release Notes/im'
# Version labels.
- label: minor
title:
- "/^feat:/i"
- label: patch
title:
- "/^fix:/i"
- "/^sec:/i"
- "/^chore:/i"
branch:
- '/^renovate_/'
# Languages detection.
- label: go
files:
- '*.go'
- 'go.mod'
- 'go.sum'
- label: python
files:
- '*.py'
- label: javascript
files:
- '*.js'
replacers:
# Remove unlabeled or uncategorized PRs.
- search: "/# What's Changed.*?\\n## /s"
replace: "# What's Changed\n\n## "
template: |
# What's Changed
$CHANGES
59 changes: 59 additions & 0 deletions .github/renovate.json5
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"schedule:nonOfficeHours", // https://docs.renovatebot.com/presets-schedule/#schedulenonofficehours
":enableVulnerabilityAlertsWithLabel(security)", // https://docs.renovatebot.com/presets-default/#enablevulnerabilityalertswithlabelarg0
"group:recommended", // https://docs.renovatebot.com/presets-group/#grouprecommended
"workarounds:all", // https://docs.renovatebot.com/presets-workarounds/#workaroundsall
// Automerge configuration.
":automergeMinor",
":automergePr",
":automergeRequireAllStatusChecks",
],
"reviewersFromCodeOwners": true,
"dependencyDashboard": true,
"semanticCommits": "disabled",
"labels": ["dependencies", "renovate"],
"prHourlyLimit": 5,
"prConcurrentLimit": 5,
"rebaseWhen": "conflicted",
"rangeStrategy": "pin",
"branchPrefix": "renovate_",
"commitMessagePrefix": "chore:",
// This will run go mod tidy after each go.mod update.
"postUpdateOptions": ["gomodTidy"],
// Groups:
"packageRules": [
{
"matchManagers": ["gomod"],
"matchUpdateTypes": [
"minor",
"patch",
],
"groupName": "Minor and patch Golang dependencies",
},
{
"matchManagers": ["github-actions"],
"addLabels": ["github-actions"],
"groupName": "GitHub Actions",
},
{
"matchManagers": ["gomod"],
"addLabels": ["golang"],
},
{
"matchManagers": ["npm"],
"addLabels": ["javascript"],
"groupName": "JS dependencies",
},
],
// Custom version extraction from Makefile.
"regexManagers": [
{
"fileMatch": ["^Makefile$"],
"matchStrings": [
".*renovate datasource=(?<datasource>.*?) depName=(?<depName>.*?)\\n.*?_VERSION\\s?:=\\s?(?<currentValue>.*)\\s"
]
}
],
}
80 changes: 80 additions & 0 deletions .github/scripts/release-notes.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
#!/usr/bin/env bash

set -euo pipefail

if [ "$#" -ne 1 ]; then
echo "Provide a single argument with a version of the release draft to use." >&2
echo "Usage: $0 <VERSION>"
exit 1
fi

VERSION="$1"

RELEASE_NOTES=$(gh release view "$VERSION" --json body --jq .body)

BREAKING_CHANGES_HEADER="Breaking Changes"
RELEASE_NOTES_HEADER="Release Notes"

commit_message_re="-\s(.*)\s(\(#[0-9]+\)\s@.*)"
rls_header_re="^##.*(Features|$BREAKING_CHANGES_HEADER|Bug Fixes|Fixed Vulnerabilities)"

extract_header() {
local commit="$1"
local header_name="$2"
awk "
/^\s?$/ {next}
/## $header_name/ {rn=1}
rn && !/^##/ {print};
/##/ && !/## $header_name/ {rn=0}" <<<"$commit"
}

indent() {
while IFS= read -r line; do
printf " %s\n" "${line%"${line##*[![:space:]]}"}"
done <<<"$1"
}

new_notes=""
rls_header=""
while IFS= read -r line; do
new_notes+="$line\n"
if [[ $line == \##* ]]; then
if ! [[ $line =~ $rls_header_re ]]; then
rls_header=""
continue
fi
rls_header="${BASH_REMATCH[1]}"
fi
if [[ $rls_header == "" ]]; then
continue
fi
if [[ $line != -* ]]; then
continue
fi
if ! [[ $line =~ $commit_message_re ]]; then
continue
fi
commit_msg="${BASH_REMATCH[1]}"
commit_body=$(git log --grep "$commit_msg" -n1 --pretty="%b")

add_notes() {
local notes="$1"
if [[ $notes != "" ]]; then
new_notes+=$(indent "> $notes")
new_notes+="\n"
fi
}

rn=$(extract_header "$commit_body" "$RELEASE_NOTES_HEADER")
bc=$(extract_header "$commit_body" "$BREAKING_CHANGES_HEADER")

case $rls_header in
"$BREAKING_CHANGES_HEADER") add_notes "$bc" ;;
*) add_notes "$rn" ;;
esac

done <<<"$RELEASE_NOTES"

echo "Uploading release notes for $VERSION"
# shellcheck disable=2059
printf "$new_notes" | gh release edit "$VERSION" --verify-tag -F -
44 changes: 44 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Checks
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
check:
name: Run all checks for static analysis
runs-on: ubuntu-latest
env:
GO111MODULE: on
steps:
- name: Check out code
uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
check-latest: true
- name: Set up prerequisites - node and yarn
uses: actions/setup-node@v4
- name: Set up yarn cache
id: yarn-cache
run: echo "::set-output name=dir::$(yarn cache dir)"
- uses: actions/cache@v4
with:
path: ${{ steps.yarn-cache.outputs.dir }}
key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
restore-keys: |
${{ runner.os }}-yarn-
- name: Run spell and markdown checkers
run: make check/spell check/trailing check/markdown
- name: Check generated code
run: make check/generate
- name: Check formatting
run: make check/format
- name: Run go vet
run: make check/vet
- name: Run golangci-lint
run: make check/lint
- name: Run Gosec Security Scanner
run: make check/gosec
13 changes: 13 additions & 0 deletions .github/workflows/pr-title.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
on:
pull_request:
types: [opened, reopened, edited]
merge_group:
name: pr-title
jobs:
pr-title-check:
runs-on: ubuntu-latest
steps:
- uses: Slashgear/action-check-pr-title@v4.3.0
with:
regexp: "(feat|fix|sec|infra|test|chore|doc): .{5,}"
helpMessage: "Example: 'feat: new pr title check BE-143' <- prefix, colon, space, PR title of at least 5 chars (with ticket number strongly suggested, but not mandatory)"
37 changes: 37 additions & 0 deletions .github/workflows/release-drafter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Release Drafter

on:
push:
branches:
- main
# pull_request event is required only for autolabeler
# 'edited' event is required to account for initial invalid PR names
pull_request:
types: [opened, reopened, synchronize, edited]

permissions:
contents: read

jobs:
update_release_draft:
permissions:
# write permission is required to create a github release
contents: write
# write permission is required for autolabeler
# otherwise, read permission is required at least
pull-requests: write
runs-on: ubuntu-latest
env:
GITHUB_TOKEN: ${{ secrets.RELEASE_LABELER_TOKEN }}
steps:
- name: Checkout code
uses: actions/checkout@v4
with:
ref: main
fetch-depth: 0
# Drafts your next Release notes as Pull Requests are merged into "main"
- id: drafter
uses: release-drafter/release-drafter@v5
- name: Add release notes to the draft
if: github.event_name == 'push'
run: .github/scripts/release-notes.sh ${{ steps.drafter.outputs.tag_name }}
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ on:
push:
tags:
- "v*"

jobs:
goreleaser:
runs-on: ubuntu-latest
Expand Down
21 changes: 21 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Tests
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
test:
name: Run unit tests
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v4
- uses: actions/setup-go@v5
with:
go-version-file: go.mod
cache: false
- name: Run unit tests
run: make test
Loading

0 comments on commit a3f8bce

Please sign in to comment.