Skip to content

Commit cb287a9

Browse files
authored
Merge pull request #12 from everettraven/chore/sig-donation-requirements
2 parents a473b8a + 4de0306 commit cb287a9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1592
-563
lines changed

.bingo/.gitignore

Lines changed: 0 additions & 13 deletions
This file was deleted.

.bingo/README.md

Lines changed: 0 additions & 14 deletions
This file was deleted.

.bingo/Variables.mk

Lines changed: 0 additions & 25 deletions
This file was deleted.

.bingo/go.mod

Lines changed: 0 additions & 1 deletion
This file was deleted.

.bingo/golangci-lint.mod

Lines changed: 0 additions & 7 deletions
This file was deleted.

.bingo/variables.env

Lines changed: 0 additions & 12 deletions
This file was deleted.

.golangci.yaml

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
version: "2"
2+
linters:
3+
default: none
4+
# Enable specific linter
5+
# https://golangci-lint.run/usage/linters/#enabled-by-default-linters
6+
enable:
7+
- asciicheck
8+
- bidichk
9+
- bodyclose
10+
- contextcheck
11+
- cyclop
12+
- dogsled
13+
- dupl
14+
- durationcheck
15+
- err113
16+
- errcheck
17+
- errname
18+
- errorlint
19+
- exhaustive
20+
- forcetypeassert
21+
- gochecknoglobals
22+
- gocognit
23+
- goconst
24+
- gocritic
25+
- gocyclo
26+
- godot
27+
- goheader
28+
- goprintffuncname
29+
- gosec
30+
- govet
31+
- importas
32+
- ineffassign
33+
- makezero
34+
- misspell
35+
- nakedret
36+
- nestif
37+
- nilerr
38+
- nilnil
39+
- nlreturn
40+
- noctx
41+
- nolintlint
42+
- prealloc
43+
- predeclared
44+
- revive
45+
- staticcheck
46+
- tagliatelle
47+
- unconvert
48+
- unparam
49+
- unused
50+
- wastedassign
51+
- whitespace
52+
- wrapcheck
53+
- wsl
54+
settings:
55+
goheader:
56+
values:
57+
regexp:
58+
license-year: (202[5-9]|20[3-9][0-9])
59+
template: |-
60+
Copyright {{license-year}} The Kubernetes Authors.
61+
62+
Licensed under the Apache License, Version 2.0 (the "License");
63+
you may not use this file except in compliance with the License.
64+
You may obtain a copy of the License at
65+
66+
http://www.apache.org/licenses/LICENSE-2.0
67+
68+
Unless required by applicable law or agreed to in writing, software
69+
distributed under the License is distributed on an "AS IS" BASIS,
70+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
71+
See the License for the specific language governing permissions and
72+
limitations under the License.
73+
nlreturn:
74+
block-size: 2
75+
revive:
76+
confidence: 0
77+
rules:
78+
- name: exported
79+
arguments:
80+
- checkPrivateReceivers
81+
- disableStutteringCheck
82+
severity: warning
83+
disabled: false
84+
staticcheck:
85+
# https://staticcheck.io/docs/options#checks
86+
checks:
87+
- all
88+
- -ST1000
89+
dot-import-whitelist:
90+
- github.com/onsi/ginkgo/v2
91+
- github.com/onsi/gomega
92+
exclusions:
93+
generated: lax
94+
rules:
95+
- linters:
96+
- dupl
97+
- err113
98+
- funlen
99+
- gochecknoglobals
100+
- gocyclo
101+
- gosec
102+
# Exclude some linters from running on tests files.
103+
path: _test\.go
104+
- linters:
105+
- all
106+
path: testdata
107+
- path: (.+)\.go$
108+
text: Analyzer is a global variable
109+
paths:
110+
- third_party$
111+
- builtin$
112+
- examples$
113+
formatters:
114+
enable:
115+
- gofmt
116+
- goimports
117+
exclusions:
118+
generated: lax
119+
paths:
120+
- third_party$
121+
- builtin$
122+
- examples$

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing Guidelines
2+
3+
Welcome to Kubernetes. We are excited about the prospect of you joining our [community](https://git.k8s.io/community)! The Kubernetes community abides by the CNCF [code of conduct](code-of-conduct.md). Here is an excerpt:
4+
5+
_As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities._
6+
7+
## Getting Started
8+
9+
We have full documentation on how to get started contributing here:
10+
11+
<!---
12+
If your repo has certain guidelines for contribution, put them here ahead of the general k8s resources
13+
-->
14+
15+
- [Contributor License Agreement](https://git.k8s.io/community/CLA.md) - Kubernetes projects require that you sign a Contributor License Agreement (CLA) before we can accept your pull requests
16+
- [Kubernetes Contributor Guide](https://k8s.dev/guide) - Main contributor documentation, or you can just jump directly to the [contributing page](https://k8s.dev/docs/guide/contributing/)
17+
- [Contributor Cheat Sheet](https://k8s.dev/cheatsheet) - Common resources for existing developers
18+
19+
## Mentorship
20+
21+
- [Mentoring Initiatives](https://k8s.dev/community/mentoring) - We have a diverse set of mentorship programs available that are always looking for volunteers!
22+
23+
<!---
24+
Custom Information - if you're copying this template for the first time you can add custom content here, for example:
25+
26+
## Contact Information
27+
28+
- [Slack channel](https://kubernetes.slack.com/messages/kubernetes-users) - Replace `kubernetes-users` with your slack channel string, this will send users directly to your channel.
29+
- [Mailing list](URL)
30+
-->

Makefile

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@
33
SHELL := /usr/bin/env bash -o pipefail
44
.SHELLFLAGS := -ec
55

6-
include .bingo/Variables.mk
6+
# Tool definitions
7+
GOLANGCI_LINT := go tool -modfile tools/go.mod github.com/golangci/golangci-lint/v2/cmd/golangci-lint
78

89
.PHONY: lint
9-
lint: $(GOLANGCI_LINT)
10+
lint: golangci-lint
11+
12+
.PHONY: golangci-lint
13+
golangci-lint:
1014
$(GOLANGCI_LINT) run $(GOLANGCI_LINT_ARGS)
1115

1216
.PHONY: unit

OWNERS

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
approvers:
2+
- everettraven
3+
- JoelSpeed
4+
- jpbetz
5+
6+
reviewers:
7+
- everettraven
8+
- JoelSpeed
9+
- jpbetz

RELEASE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Release Process
2+
3+
The `crd-diff` project is released on an as-needed basis. The process is as follows:
4+
5+
1. An issue is proposing a new release with a changelog since the last release
6+
1. All [OWNERS](OWNERS) must LGTM this release
7+
1. An OWNER runs `git tag -s $VERSION` and inserts the changelog and pushes the tag with `git push $VERSION`
8+
1. The release issue is closed

SECURITY.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Security Policy
2+
3+
## Security Announcements
4+
5+
Join the [kubernetes-security-announce] group for security and vulnerability announcements.
6+
7+
## Reporting a Vulnerability
8+
9+
Instructions for reporting a vulnerability can be found on the
10+
[Kubernetes Security and Disclosure Information] page.
11+
12+
## Supported Versions
13+
14+
Information about supported Kubernetes versions can be found on the
15+
[Kubernetes version and version skew support policy] page on the Kubernetes website.
16+
17+
[kubernetes-security-announce]: https://groups.google.com/forum/#!forum/kubernetes-security-announce
18+
[Kubernetes version and version skew support policy]: https://kubernetes.io/docs/setup/release/version-skew-policy/#supported-versions
19+
[Kubernetes Security and Disclosure Information]: https://kubernetes.io/docs/reference/issues-security/security/#report-a-vulnerability

SECURITY_CONTACTS

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Defined below are the security contacts for this repo.
2+
#
3+
# They are the contact point for the Security Response Committee to reach out
4+
# to for triaging and handling of incoming issues.
5+
#
6+
# The below names agree to abide by the
7+
# [Embargo Policy](https://git.k8s.io/security/private-distributors-list.md#embargo-policy)
8+
# and will be removed and replaced if they violate that agreement.
9+
#
10+
# DO NOT REPORT SECURITY VULNERABILITIES DIRECTLY TO THESE NAMES, FOLLOW THE
11+
# INSTRUCTIONS AT https://kubernetes.io/security/
12+
13+
everettraven
14+
JoelSpeed
15+
jpbetz

cli/root.go

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
// Copyright 2025 The Kubernetes Authors.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
115
package cli
216

317
import (
@@ -17,6 +31,7 @@ import (
1731
crconfig "sigs.k8s.io/controller-runtime/pkg/client/config"
1832
)
1933

34+
// NewRootCommand returns a cobra.Command for the program entrypoint.
2035
func NewRootCommand() *cobra.Command {
2136
loader := composite.NewComposite(
2237
map[string]composite.Loader{
@@ -26,8 +41,10 @@ func NewRootCommand() *cobra.Command {
2641
},
2742
)
2843

29-
var configFile string
30-
var outputFormat string
44+
var (
45+
configFile string
46+
outputFormat string
47+
)
3148

3249
rootCmd := &cobra.Command{
3350
Use: "crd-diff <old> <new>",

cli/version.go

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
// Copyright 2025 The Kubernetes Authors.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
115
package cli
216

317
import (
@@ -10,6 +24,8 @@ import (
1024
"github.com/spf13/cobra"
1125
)
1226

27+
// NewVersionCommand returns a new cobra.Command
28+
// for printing the current version of crd-diff.
1329
func NewVersionCommand() *cobra.Command {
1430
versionCommand := &cobra.Command{
1531
Use: "version",
@@ -32,5 +48,6 @@ func NewVersionCommand() *cobra.Command {
3248
fmt.Print(out.String())
3349
},
3450
}
51+
3552
return versionCommand
3653
}

code-of-conduct.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Kubernetes Community Code of Conduct
2+
3+
Please refer to our [Kubernetes Community Code of Conduct](https://git.k8s.io/community/code-of-conduct.md)

main.go

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
// Copyright 2025 The Kubernetes Authors.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
115
package main
216

317
import (

0 commit comments

Comments
 (0)