Skip to content

Commit 912f2df

Browse files
everettraveneverettraven
committed
change module and documentation references from crd-diff to crdify
Signed-off-by: Bryce Palmer <bpalmer@redhat.com>
1 parent cb287a9 commit 912f2df

Some content is hidden

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

42 files changed

+108
-108
lines changed

‎Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ unit:
1919

2020
.PHONY: build
2121
build:
22-
go build -o bin/crd-diff main.go
22+
go build -o bin/crdify main.go
2323

2424
.PHONY: fmt
2525
fmt:

‎README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,41 @@
1-
# crd-diff
2-
`crd-diff` is a CLI tool for comparing Kubernetes `CustomResourceDefinition` resources (CRDs) for differences.
1+
# crdify
2+
`crdify` is a CLI tool for comparing Kubernetes `CustomResourceDefinition` resources (CRDs) for differences.
33
It checks for incompatible changes to help:
44
- Cluster administrators protect CRDs on their clusters from breaking changes
55
- GitOps practitioners prevent CRDs with breaking changes being committed
66
- Developers of Kubernetes extension identify when changes to their CRDs are incompatible
77

88
## Usage
99
```sh
10-
crd-diff is a tool for evaluating changes to Kubernetes CustomResourceDefinitions
10+
crdify is a tool for evaluating changes to Kubernetes CustomResourceDefinitions
1111
to help cluster administrators, gitops practitioners, and Kubernetes extension developers identify
1212
changes that might result in a negative impact to clusters and/or users.
1313

1414
Example use cases:
1515
Evaluating a change in a CustomResourceDefinition on a Kubernetes Cluster with one in a file:
16-
$ crd-diff kube://{crd-name} file://{filepath}
16+
$ crdify kube://{crd-name} file://{filepath}
1717

1818
Evaluating a change from file to file:
19-
$ crd-diff file://{filepath} file://{filepath}
19+
$ crdify file://{filepath} file://{filepath}
2020

2121
Evaluating a change from git ref to git ref:
22-
$ crd-diff git://{ref}?path={filepath} git://{ref}?path={filepath}
22+
$ crdify git://{ref}?path={filepath} git://{ref}?path={filepath}
2323

2424
Usage:
25-
crd-diff <old> <new> [flags]
26-
crd-diff [command]
25+
crdify <old> <new> [flags]
26+
crdify [command]
2727

2828
Available Commands:
2929
completion Generate the autocompletion script for the specified shell
3030
help Help about any command
31-
version installed version of crd-diff
31+
version installed version of crdify
3232

3333
Flags:
3434
--config string the filepath to load the check configurations from
35-
-h, --help help for crd-diff
35+
-h, --help help for crdify
3636
-o, --output string the format the output should take when incompatibilities are identified. May be one of plaintext, json, yaml (default "plaintext")
3737

38-
Use "crd-diff [command] --help" for more information about a command.
38+
Use "crdify [command] --help" for more information about a command.
3939
```
4040

4141
The `<old>` and `<new>` arguments are required and should be the sourcing information for the old and new
@@ -46,16 +46,16 @@ The supported sources are:
4646
- `git://{ref}?path={filepath}`
4747
- `file://{filepath}`
4848

49-
An example of using `crd-diff` to compare a `CustomResourceDefinition` on a Kubernetes cluster to the same one in a local file:
49+
An example of using `crdify` to compare a `CustomResourceDefinition` on a Kubernetes cluster to the same one in a local file:
5050
```sh
51-
crd-diff kube://memcacheds.cache.example.com file://crd.yaml
51+
crdify kube://memcacheds.cache.example.com file://crd.yaml
5252
```
5353

5454
## Installation
5555

56-
`crd-diff` can be installed by running:
56+
`crdify` can be installed by running:
5757
```sh
58-
go install github.com/everettraven/crd-diff@{revision}
58+
go install sigs.k8s.io/crdify@{revision}
5959
```
6060

6161
Replace `{revision}` with a tag, commit, or `latest` to build and install the tool from source at that particular revision.

‎RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Release Process
22

3-
The `crd-diff` project is released on an as-needed basis. The process is as follows:
3+
The `crdify` project is released on an as-needed basis. The process is as follows:
44

55
1. An issue is proposing a new release with a changelog since the last release
66
1. All [OWNERS](OWNERS) must LGTM this release

‎cli/root.go

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@ import (
1919
"log"
2020
"os"
2121

22-
"github.com/everettraven/crd-diff/pkg/config"
23-
"github.com/everettraven/crd-diff/pkg/loaders/composite"
24-
"github.com/everettraven/crd-diff/pkg/loaders/file"
25-
"github.com/everettraven/crd-diff/pkg/loaders/git"
26-
"github.com/everettraven/crd-diff/pkg/loaders/kubernetes"
27-
"github.com/everettraven/crd-diff/pkg/loaders/scheme"
28-
"github.com/everettraven/crd-diff/pkg/runner"
2922
"github.com/spf13/afero"
3023
"github.com/spf13/cobra"
3124
crconfig "sigs.k8s.io/controller-runtime/pkg/client/config"
25+
"sigs.k8s.io/crdify/pkg/config"
26+
"sigs.k8s.io/crdify/pkg/loaders/composite"
27+
"sigs.k8s.io/crdify/pkg/loaders/file"
28+
"sigs.k8s.io/crdify/pkg/loaders/git"
29+
"sigs.k8s.io/crdify/pkg/loaders/kubernetes"
30+
"sigs.k8s.io/crdify/pkg/loaders/scheme"
31+
"sigs.k8s.io/crdify/pkg/runner"
3232
)
3333

3434
// NewRootCommand returns a cobra.Command for the program entrypoint.
@@ -47,21 +47,21 @@ func NewRootCommand() *cobra.Command {
4747
)
4848

4949
rootCmd := &cobra.Command{
50-
Use: "crd-diff <old> <new>",
51-
Short: "crd-diff evaluates changes to Kubernetes CustomResourceDefinitions",
52-
Long: `crd-diff is a tool for evaluating changes to Kubernetes CustomResourceDefinitions
50+
Use: "crdify <old> <new>",
51+
Short: "crdify evaluates changes to Kubernetes CustomResourceDefinitions",
52+
Long: `crdify is a tool for evaluating changes to Kubernetes CustomResourceDefinitions
5353
to help cluster administrators, gitops practitioners, and Kubernetes extension developers identify
5454
changes that might result in a negative impact to clusters and/or users.
5555
5656
Example use cases:
57-
Evaluating a change in a CustomResourceDefinition on a Kubernetes Cluster with one in a file:
58-
$ crd-diff kube://{crd-name} file://{filepath}
57+
Ealuating a change in a CustomResourceDefinition on a Kubernetes Cluster with one in a file:
58+
$ crdify kube://{crd-name} file://{filepath}
5959
6060
Evaluating a change from file to file:
61-
$ crd-diff file://{filepath} file://{filepath}
61+
$ crdify file://{filepath} file://{filepath}
6262
6363
Evaluating a change from git ref to git ref:
64-
$ crd-diff git://{ref}?path={filepath} git://{ref}?path={filepath}`,
64+
$ crdify git://{ref}?path={filepath} git://{ref}?path={filepath}`,
6565
Args: cobra.ExactArgs(2),
6666
Run: func(cmd *cobra.Command, args []string) {
6767
cfg, err := config.Load(configFile)

‎cli/version.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ import (
2929
func NewVersionCommand() *cobra.Command {
3030
versionCommand := &cobra.Command{
3131
Use: "version",
32-
Short: "installed version of crd-diff",
32+
Short: "installed version of crdify",
3333
Run: func(cmd *cobra.Command, args []string) {
3434
var out strings.Builder
35-
fig := figure.NewFigure("crd-diff", "rounded", true)
35+
fig := figure.NewFigure("crdify", "rounded", true)
3636
out.WriteString(fig.String() + "\n\n")
3737

3838
settingNameStyle := lipgloss.NewStyle().Bold(true)

‎docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# crd-diff
2-
`crd-diff` is a CLI tool for comparing Kubernetes `CustomResourceDefinition` resources (CRDs) for differences.
1+
# crdify
2+
`crdify` is a CLI tool for comparing Kubernetes `CustomResourceDefinition` resources (CRDs) for differences.
33
It checks for incompatible changes to help:
44
- Cluster administrators protect CRDs on their clusters from breaking changes
55
- GitOps practitioners prevent CRDs with breaking changes being committed

‎docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Configuration
2-
`crd-diff` can be customized using a YAML configuration file.
2+
`crdify` can be customized using a YAML configuration file.
33

44
An example of configuring a validation via the configuration file:
55

‎docs/getting-started.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
11
# Getting Started
22

3-
## Installing `crd-diff`
4-
Currently, the only way to install the `crd-diff` tool is to use the `go install` command:
3+
## Installing `crdify`
4+
Currently, the only way to install the `crdify` tool is to use the `go install` command:
55

66
```sh
7-
go install github.com/everettraven/crd-diff@{revision}
7+
go install sigs.k8s.io/crdify@{revision}
88
```
99

1010
Replace `{revision}` with a tag, commit, or `latest` to build and install the tool from source at that particular revision.
1111

1212
## General Usage
1313

1414
```sh
15-
crd-diff is a tool for evaluating changes to Kubernetes CustomResourceDefinitions
15+
crdify is a tool for evaluating changes to Kubernetes CustomResourceDefinitions
1616
to help cluster administrators, gitops practitioners, and Kubernetes extension developers identify
1717
changes that might result in a negative impact to clusters and/or users.
1818

1919
Example use cases:
2020
Evaluating a change in a CustomResourceDefinition on a Kubernetes Cluster with one in a file:
21-
$ crd-diff kube://{crd-name} file://{filepath}
21+
$ crdify kube://{crd-name} file://{filepath}
2222

2323
Evaluating a change from file to file:
24-
$ crd-diff file://{filepath} file://{filepath}
24+
$ crdify file://{filepath} file://{filepath}
2525

2626
Evaluating a change from git ref to git ref:
27-
$ crd-diff git://{ref}?path={filepath} git://{ref}?path={filepath}
27+
$ crdify git://{ref}?path={filepath} git://{ref}?path={filepath}
2828

2929
Usage:
30-
crd-diff <old> <new> [flags]
31-
crd-diff [command]
30+
crdify <old> <new> [flags]
31+
crdify [command]
3232

3333
Available Commands:
3434
completion Generate the autocompletion script for the specified shell
3535
help Help about any command
36-
version installed version of crd-diff
36+
version installed version of crdify
3737

3838
Flags:
3939
--config string the filepath to load the check configurations from
40-
-h, --help help for crd-diff
40+
-h, --help help for crdify
4141
-o, --output string the format the output should take when incompatibilities are identified. May be one of plaintext, json, yaml (default "plaintext")
4242

43-
Use "crd-diff [command] --help" for more information about a command.
43+
Use "crdify [command] --help" for more information about a command.
4444
```
4545

4646
The `<old>` and `<new>` arguments are required and should be the sourcing information for the old and new
@@ -52,8 +52,8 @@ The supported sources are:
5252
- `git://{ref}?path={filepath}`
5353
- `file://{filepath}`
5454

55-
An example of using `crd-diff` to compare a `CustomResourceDefinition` on a Kubernetes cluster to the same one in a local file:
55+
An example of using `crdify` to compare a `CustomResourceDefinition` on a Kubernetes cluster to the same one in a local file:
5656

5757
```sh
58-
crd-diff kube://memcacheds.cache.example.com file://crd.yaml
58+
crdify kube://memcacheds.cache.example.com file://crd.yaml
5959
```

‎docs/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@
1212
<div id="app"></div>
1313
<script>
1414
window.$docsify = {
15-
name: 'crd-diff',
16-
repo: 'https://www.github.com/everettraven/crd-diff',
15+
name: 'crdify',
16+
repo: 'https://www.github.com/kubernetes-sigs/crdify',
1717
loadSidebar: true,
1818
subMaxLevel: 3,
1919
}

‎docs/validations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Validations
22

3-
`crd-diff` has three different "validators" that run:
3+
`crdify` has three different "validators" that run:
44

55
- CRD Validator - runs validations, known as "Global Validations", that verify compatibility of changes across the entire CRD.
66
- Same Version Validator - runs validations, known as "Property Validations", that verify compatibility of changes to properties within the same versions.

‎go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
module github.com/everettraven/crd-diff
1+
module sigs.k8s.io/crdify
22

33
go 1.24.0
44

‎main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ package main
1717
import (
1818
"log"
1919

20-
"github.com/everettraven/crd-diff/cli"
20+
"sigs.k8s.io/crdify/cli"
2121
)
2222

2323
func main() {

‎pkg/runner/registry.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
package runner
1616

1717
import (
18-
"github.com/everettraven/crd-diff/pkg/validations"
19-
"github.com/everettraven/crd-diff/pkg/validations/crd/existingfieldremoval"
20-
"github.com/everettraven/crd-diff/pkg/validations/crd/scope"
21-
"github.com/everettraven/crd-diff/pkg/validations/crd/storedversionremoval"
22-
"github.com/everettraven/crd-diff/pkg/validations/property"
18+
"sigs.k8s.io/crdify/pkg/validations"
19+
"sigs.k8s.io/crdify/pkg/validations/crd/existingfieldremoval"
20+
"sigs.k8s.io/crdify/pkg/validations/crd/scope"
21+
"sigs.k8s.io/crdify/pkg/validations/crd/storedversionremoval"
22+
"sigs.k8s.io/crdify/pkg/validations/property"
2323
)
2424

2525
//nolint:gochecknoglobals

‎pkg/runner/results.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import (
2020
"fmt"
2121
"strings"
2222

23-
"github.com/everettraven/crd-diff/pkg/validations"
2423
"gopkg.in/yaml.v2"
24+
"sigs.k8s.io/crdify/pkg/validations"
2525
)
2626

2727
// Results is a utility type to hold the validation results of

‎pkg/runner/runner.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ import (
1919
"maps"
2020
"slices"
2121

22-
"github.com/everettraven/crd-diff/pkg/config"
23-
"github.com/everettraven/crd-diff/pkg/validations"
24-
"github.com/everettraven/crd-diff/pkg/validators/crd"
25-
"github.com/everettraven/crd-diff/pkg/validators/version/same"
26-
"github.com/everettraven/crd-diff/pkg/validators/version/served"
2722
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
23+
"sigs.k8s.io/crdify/pkg/config"
24+
"sigs.k8s.io/crdify/pkg/validations"
25+
"sigs.k8s.io/crdify/pkg/validators/crd"
26+
"sigs.k8s.io/crdify/pkg/validators/version/same"
27+
"sigs.k8s.io/crdify/pkg/validators/version/served"
2828
)
2929

3030
// Runner is a utility struct for running

‎pkg/validations/compare.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ import (
1818
"errors"
1919
"fmt"
2020

21-
"github.com/everettraven/crd-diff/pkg/config"
2221
"github.com/google/go-cmp/cmp"
2322
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
2423
"k8s.io/apimachinery/pkg/api/equality"
24+
"sigs.k8s.io/crdify/pkg/config"
2525
)
2626

2727
// CompareVersions calculates the diff in the provided old and new CustomResourceDefinitionVersions and

‎pkg/validations/crd/existingfieldremoval/existingfieldremoval.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ import (
1818
"errors"
1919
"fmt"
2020

21-
"github.com/everettraven/crd-diff/pkg/config"
22-
"github.com/everettraven/crd-diff/pkg/validations"
2321
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
2422
"k8s.io/apimachinery/pkg/util/sets"
2523
"k8s.io/apimachinery/pkg/util/validation/field"
24+
"sigs.k8s.io/crdify/pkg/config"
25+
"sigs.k8s.io/crdify/pkg/validations"
2626
)
2727

2828
var (

‎pkg/validations/crd/existingfieldremoval/existingfieldremoval_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ package existingfieldremoval
1717
import (
1818
"testing"
1919

20-
internaltesting "github.com/everettraven/crd-diff/pkg/validations/internal/testing"
2120
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
21+
internaltesting "sigs.k8s.io/crdify/pkg/validations/internal/testing"
2222
)
2323

2424
func TestExistingFieldRemoval(t *testing.T) {

‎pkg/validations/crd/scope/scope.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ import (
1818
"errors"
1919
"fmt"
2020

21-
"github.com/everettraven/crd-diff/pkg/config"
22-
"github.com/everettraven/crd-diff/pkg/validations"
2321
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
22+
"sigs.k8s.io/crdify/pkg/config"
23+
"sigs.k8s.io/crdify/pkg/validations"
2424
)
2525

2626
var (

‎pkg/validations/crd/scope/scope_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ package scope
1717
import (
1818
"testing"
1919

20-
internaltesting "github.com/everettraven/crd-diff/pkg/validations/internal/testing"
2120
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
21+
internaltesting "sigs.k8s.io/crdify/pkg/validations/internal/testing"
2222
)
2323

2424
func TestScope(t *testing.T) {

‎pkg/validations/crd/storedversionremoval/storedversionremoval.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ import (
1818
"errors"
1919
"fmt"
2020

21-
"github.com/everettraven/crd-diff/pkg/config"
22-
"github.com/everettraven/crd-diff/pkg/validations"
2321
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
2422
"k8s.io/apimachinery/pkg/util/sets"
23+
"sigs.k8s.io/crdify/pkg/config"
24+
"sigs.k8s.io/crdify/pkg/validations"
2525
)
2626

2727
var (

0 commit comments

Comments
 (0)