Skip to content

Commit bf15e44

Browse files
authored
📖Update go version in setupenv-test README. Update release-notes link in RELEASE (kubernetes-sigs#2538)
* update go version on setupenv-test README Signed-off-by: Troy Connor <[email protected]> * fix release notes link --------- Signed-off-by: Troy Connor <[email protected]>
1 parent e25aeeb commit bf15e44

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

‎RELEASE.md

+9-5
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ The Kubernetes controller-runtime Project is released on an as-needed basis. The
44

55
**Note:** Releases are done from the `release-MAJOR.MINOR` branches. For PATCH releases is not required
66
to create a new branch you will just need to ensure that all big fixes are cherry-picked into the respective
7-
`release-MAJOR.MINOR` branch. To know more about versioning check https://semver.org/.
7+
`release-MAJOR.MINOR` branch. To know more about versioning check https://semver.org/.
88

9-
## How to do a release
9+
## How to do a release
1010

1111
### Create the new branch and the release tag
1212

@@ -15,7 +15,7 @@ to create a new branch you will just need to ensure that all big fixes are cherr
1515

1616
### Now, let's generate the changelog
1717

18-
1. Create the changelog from the new branch `release-<MAJOR.MINOR>` (`git checkout release-<MAJOR.MINOR>`).
18+
1. Create the changelog from the new branch `release-<MAJOR.MINOR>` (`git checkout release-<MAJOR.MINOR>`).
1919
You will need to use the [kubebuilder-release-tools][kubebuilder-release-tools] to generate the notes. See [here][release-notes-generation]
2020

2121
> **Note**
@@ -24,12 +24,12 @@ You will need to use the [kubebuilder-release-tools][kubebuilder-release-tools]
2424
2525
### Draft a new release from GitHub
2626

27-
1. Create a new tag with the correct version from the new `release-<MAJOR.MINOR>` branch
27+
1. Create a new tag with the correct version from the new `release-<MAJOR.MINOR>` branch
2828
2. Add the changelog on it and publish. Now, the code source is released !
2929

3030
### Add a new Prow test the for the new branch release
3131

32-
1. Create a new prow test under [github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/controller-runtime](https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/controller-runtime)
32+
1. Create a new prow test under [github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/controller-runtime](https://github.com/kubernetes/test-infra/tree/master/config/jobs/kubernetes-sigs/controller-runtime)
3333
for the new `release-<MAJOR.MINOR>` branch. (i.e. for the `0.11.0` release see the PR: https://github.com/kubernetes/test-infra/pull/25205)
3434
2. Ping the infra PR in the controller-runtime slack channel for reviews.
3535

@@ -45,3 +45,7 @@ For more info, see the release page: https://github.com/kubernetes-sigs/controll
4545
````
4646

4747
2. An announcement email is sent to `[email protected]` with the subject `[ANNOUNCE] Controller-Runtime $VERSION is released`
48+
49+
[kubebuilder-release-tools]: https://github.com/kubernetes-sigs/kubebuilder-release-tools
50+
[release-notes-generation]: https://github.com/kubernetes-sigs/kubebuilder-release-tools/blob/master/README.md#release-notes-generation
51+
[release-process]: https://github.com/kubernetes-sigs/kubebuilder/blob/master/VERSIONING.md#releasing

‎tools/setup-envtest/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This is a small tool that manages binaries for envtest. It can be used to
44
download new binaries, list currently installed and available ones, and
55
clean up versions.
66

7-
To use it, just go-install it on 1.16+ (it's a separate, self-contained
7+
To use it, just go-install it on 1.19+ (it's a separate, self-contained
88
module):
99

1010
```shell
@@ -45,7 +45,7 @@ setup-envtest sideload 1.16.2 < downloaded-envtest.tar.gz
4545
## Where does it put all those binaries?
4646

4747
By default, binaries are stored in a subdirectory of an OS-specific data
48-
directory, as per the OS's conventions.
48+
directory, as per the OS's conventions.
4949

5050
On Linux, this is `$XDG_DATA_HOME`; on Windows, `%LocalAppData`; and on
5151
OSX, `~/Library/Application Support`.

0 commit comments

Comments
 (0)