mirror of
https://github.com/cozystack/cozystack.git
synced 2026-10-28 23:57:08 +09:00
Timofei Larkin
dec840e938
Fix schema-diff correctness: guard nil head on removed child schemas, flag adding a type to a previously-unconstrained field, stop reporting a head becoming unconstrained as narrowing, detect additionalProperties:false, and only recurse items/additionalProperties when both sides carry a schema. Gate resource and group removal as new categories. Filter CRD versions to served ones so the deprecation flow surfaces as a removed version, and flag added x-kubernetes-validations (CEL) rules. Discover first-party cozystack.io CRDs by walking crds/ and definitions/ dirs so a relocated CRD (e.g. cozystack-scheduler) is covered, and error on an empty snapshot. Surface unmapped apiserver storage prefixes and allow hyphens in plurals; drop Markdown from text-mode reports. Workflow: diff against the true merge base, count only each reviewer's latest review on the current head commit, and scope the token to the approval step with persist-credentials:false. Assisted-By: Claude <noreply@anthropic.com> Signed-off-by: Timofei Larkin <lllamnyp@gmail.com>
98 lines
2.6 KiB
Go
98 lines
2.6 KiB
Go
/*
|
|
Copyright 2026 The Cozystack Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
package apigate
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
)
|
|
|
|
// categoryTitles gives each category a stable, human-readable heading.
|
|
var categoryTitles = map[Category]string{
|
|
NewGroup: "New API group",
|
|
NewResource: "New resource",
|
|
RemovedGroup: "Removed API group",
|
|
RemovedResource: "Removed resource",
|
|
Breaking: "Breaking change to existing API",
|
|
}
|
|
|
|
// categoryOrder is the stable order categories are rendered in.
|
|
var categoryOrder = []Category{NewGroup, NewResource, RemovedGroup, RemovedResource, Breaking}
|
|
|
|
// Report renders findings for CI consumption. format "markdown" (default)
|
|
// produces a PR-comment-friendly summary; any other value produces plain text.
|
|
func Report(findings []Finding, format string) string {
|
|
if len(findings) == 0 {
|
|
return "No sizeable API changes detected.\n"
|
|
}
|
|
var b strings.Builder
|
|
md := format != "text"
|
|
|
|
if md {
|
|
b.WriteString("### Sizeable API change detected\n\n")
|
|
b.WriteString("This change touches the API surface in a way that requires review from a designated API owner.\n\n")
|
|
} else {
|
|
b.WriteString("Sizeable API change detected:\n\n")
|
|
}
|
|
|
|
for _, cat := range categoryOrder {
|
|
group := findingsOf(findings, cat)
|
|
if len(group) == 0 {
|
|
continue
|
|
}
|
|
if md {
|
|
fmt.Fprintf(&b, "#### %s\n\n", categoryTitles[cat])
|
|
} else {
|
|
fmt.Fprintf(&b, "%s:\n", categoryTitles[cat])
|
|
}
|
|
for _, f := range group {
|
|
line := fmt.Sprintf("%s %s — %s (%s)", identity(f, md), f.Detail, f.Origin, f.Source)
|
|
if md {
|
|
fmt.Fprintf(&b, "- %s\n", line)
|
|
} else {
|
|
fmt.Fprintf(&b, " - %s\n", line)
|
|
}
|
|
}
|
|
b.WriteString("\n")
|
|
}
|
|
return b.String()
|
|
}
|
|
|
|
// identity renders the resource identity, emphasized only in Markdown mode so
|
|
// text output stays free of markup.
|
|
func identity(f Finding, markdown bool) string {
|
|
kind := f.Kind
|
|
if kind == "" {
|
|
kind = f.Plural
|
|
}
|
|
id := fmt.Sprintf("%s/%s", f.Group, kind)
|
|
if markdown {
|
|
return "**" + id + "**"
|
|
}
|
|
return id
|
|
}
|
|
|
|
func findingsOf(findings []Finding, cat Category) []Finding {
|
|
var out []Finding
|
|
for _, f := range findings {
|
|
if f.Category == cat {
|
|
out = append(out, f)
|
|
}
|
|
}
|
|
return out
|
|
}
|