Skip to content

Commit 3aba3cb

Browse files
twoGiantstekton-robot
authored andcommitted
docs: fix wrong entry in development documentation
Change the docker registry entry for KO to `localhost:5000`. The former entry `kind.local` lead to an error when deploying the local pipeline build. Fix a broken link in the testing documentation and remove a leftover comment from the makefile which was targeted to a non existing configuration. Add optional installation recommendation for `yamllint` so that it can be used when running `pre-commit` locally otherwise it will show a `Failed` message when linting yaml files. Issue #8660 Issue #8486 Signed-off-by: Stanislav Jakuschevskij <[email protected]>
1 parent a8a8c81 commit 3aba3cb

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

Diff for: DEVELOPMENT.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ You must install these tools:
9595

9696
1. [`go-licenses`](https://github.com/google/go-licenses) is used in e2e tests.
9797

98+
1. (Optional)
99+
[`yamllint`](https://github.com/adrienverge/yamllint?tab=readme-ov-file#installation)
100+
is run against every PR as part of `pre-commit`. You may want to install this tool
101+
so that `pre-commit` can use it, otherwise it will show a `failed` message for
102+
when linting yaml files.
103+
98104
1. (Optional)
99105
[`golangci-lint`](https://golangci-lint.run/welcome/install/#local-installation)
100106
is run against every PR. You may want to install and [run this tool
@@ -303,7 +309,7 @@ The recommended minimum development configuration is:
303309
4. Configure [ko](https://kind.sigs.k8s.io/):
304310
305311
```sh
306-
$ export KO_DOCKER_REPO="kind.local"
312+
$ export KO_DOCKER_REPO="localhost:5000"
307313
$ export KIND_CLUSTER_NAME="kind" # only needed if you used a custom name in the previous step
308314
```
309315

Diff for: Makefile

-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ TESTPKGS = $(shell env GO111MODULE=on $(GO) list -f \
99
BIN = $(CURDIR)/.bin
1010
WOKE ?= go run -modfile go.mod github.com/get-woke/woke
1111

12-
# Get golangci_version from tools/go.mod
1312
GOLANGCI_VERSION := $(shell yq '.jobs.linting.steps[] | select(.name == "golangci-lint") | .with.version' .github/workflows/ci.yaml)
1413
WOKE_VERSION = v0.19.0
1514

Diff for: test/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -410,7 +410,7 @@ via the sections for `tektoncd/pipeline`.
410410
411411
The presubmit integration tests entrypoint will run:
412412
413-
- [The integration tests](#integration-tests)
413+
- [The integration tests](#end-to-end-tests)
414414
- A test of [our example CRDs](../examples/README.md#testing-the-examples)
415415
416416
When run using Prow, integration tests will try to get a new cluster using

0 commit comments

Comments
 (0)