Skip to content

Commit fc1b655

Browse files
authored
Merge pull request #2924 from Eileen-Yu/test/drop-old-version
📖 docs: guide to manage k8s version for testing
2 parents c2236c3 + cabcc6b commit fc1b655

File tree

1 file changed

+20
-17
lines changed

1 file changed

+20
-17
lines changed

CONTRIBUTING.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,27 +43,28 @@ $ git clone [email protected]:<user>/kubebuilder.git $GOPATH/src/sigs.k8s.io/kubebu
4343

4444
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/`
4545
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`.
4748

4849
**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.
4950

5051
Following the targets that can be used to test your changes locally.
5152

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 |
53+
| Command | Description | Is called in the CI? |
54+
| ------------------- | ------------------------------------------------------------- | -------------------- |
55+
| make test-unit | Runs go tests | no |
56+
| 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 |
6162

6263
**NOTE** To use the `make lint` is required to install `golangci-lint` locally. More info: https://github.com/golangci/golangci-lint#install
6364

6465
## PR Process
6566

66-
See [VERSIONING.md](VERSIONING.md) for a full description. TL;DR:
67+
See [VERSIONING.md](VERSIONING.md) for a full description. TL;DR:
6768

6869
Every PR should be annotated with an icon indicating whether it's
6970
a:
@@ -90,8 +91,9 @@ separately.
9091
## Where the CI Tests are configured
9192

9293
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.
9597

9698
## How to contribute to docs
9799

@@ -115,19 +117,20 @@ Check the CI job after to do the Pull Request and then, click on in the `Details
115117
Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
116118

117119
You can reach the maintainers of this project at:
120+
118121
- [Slack](http://slack.k8s.io/)
119122
- [Mailing List](https://groups.google.com/forum/#!forum/kubebuilder)
120123

121124
## Becoming a reviewer or approver
122125

123126
Contributors may eventually become official reviewers or approvers in
124-
Kubebuilder and the related repositories. See
127+
Kubebuilder and the related repositories. See
125128
[CONTRIBUTING-ROLES.md](docs/CONTRIBUTING-ROLES.md) for more information.
126129

127130
## Code of conduct
128131

129132
Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).
130133

131-
[golangci]:https://github.com/golangci/golangci-lint
132-
[kind]:https://kind.sigs.k8s.io/#installation-and-usage
133-
[setup-envtest]:https://book.kubebuilder.io/reference/envtest
134+
[golangci]: https://github.com/golangci/golangci-lint
135+
[kind]: https://kind.sigs.k8s.io/#installation-and-usage
136+
[setup-envtest]: https://book.kubebuilder.io/reference/envtest

0 commit comments

Comments
 (0)