You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1. Run the script `make generate` to update/generate the mock data used in the e2e test in `$GOPATH/src/sigs.k8s.io/kubebuilder/testdata/`
45
45
1. Run `make test-unit test-e2e-local`
46
-
- e2e tests use [`kind`][kind] and [`setup-envtest`][setup-envtest]. If you want to bring your own binaries, place them in `$(go env GOPATH)/bin`.
46
+
47
+
- e2e tests use [`kind`][kind] and [`setup-envtest`][setup-envtest]. If you want to bring your own binaries, place them in `$(go env GOPATH)/bin`.
47
48
48
49
**IMPORTANT:** The `make generate` is very helpful. By using it, you can check if good part of the commands still working successfully after the changes. Also, note that its usage is a pre-requirement to submit a PR.
49
50
50
51
Following the targets that can be used to test your changes locally.
51
52
52
-
| Command |Description |Is called in the CI? |
53
-
|---|---|---|
54
-
| make test-unit |Runs go tests | no |
55
-
| make test| Runs tests in shell (`./test.sh`)|yes |
56
-
| make lint |Run [golangci][golangci] lint checks | yes |
57
-
| make lint-fix | Run [golangci][golangci] to automatically perform fixes | no |
58
-
| make test-coverage |Run coveralls to check the % of code covered by tests | yes |
59
-
| make check-testdata |Checks if the testdata dir is updated with the latest changes | yes |
60
-
| make test-e2e-local |Runs the CI e2e tests locally | no |
| make test| Runs tests in shell (`./test.sh`)|yes |
57
+
| make lint |Run [golangci][golangci] lint checks | yes|
58
+
| make lint-fix |Run [golangci][golangci] to automatically perform fixes | no|
59
+
| make test-coverage |Run coveralls to check the % of code covered by tests | yes|
60
+
| make check-testdata | Checks if the testdata dir is updated with the latest changes | yes|
61
+
| make test-e2e-local | Runs the CI e2e tests locally | no|
61
62
62
63
**NOTE** To use the `make lint` is required to install `golangci-lint` locally. More info: https://github.com/golangci/golangci-lint#install
63
64
64
65
## PR Process
65
66
66
-
See [VERSIONING.md](VERSIONING.md) for a full description. TL;DR:
67
+
See [VERSIONING.md](VERSIONING.md) for a full description. TL;DR:
67
68
68
69
Every PR should be annotated with an icon indicating whether it's
69
70
a:
@@ -90,8 +91,9 @@ separately.
90
91
## Where the CI Tests are configured
91
92
92
93
1. See the [action files](.github/workflows) to check its tests, and the scripts used on it.
93
-
1. Note that the prow tests used in the CI are configured in [kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml).
94
-
1. Check that all scripts used by the CI are defined in the project.
94
+
2. Note that the prow tests used in the CI are configured in [kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml](https://github.com/kubernetes/test-infra/blob/master/config/jobs/kubernetes-sigs/kubebuilder/kubebuilder-presubmits.yaml).
95
+
3. Check that all scripts used by the CI are defined in the project.
96
+
4. Notice that our policy to test the project is to run against k8s version N-2. So that the old version should be removed when there is a new k8s version available.
95
97
96
98
## How to contribute to docs
97
99
@@ -115,19 +117,20 @@ Check the CI job after to do the Pull Request and then, click on in the `Details
115
117
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
0 commit comments