Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix wrong entry in development documentation and other minor documentation corrections. #8661

Conversation

twoGiants
Copy link
Contributor

@twoGiants twoGiants commented Mar 24, 2025

Changes

Change the docker registry entry for KO_DOCKER_REPO to localhost:5000. The former entry kind.local (here) 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.

Screenshot from 2025-03-24 12-29-16

Closes #8660
Closes #8486

/kind bug

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added kind/bug Categorizes issue or PR as related to a bug. release-note-none Denotes a PR that doesnt merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Mar 24, 2025
@tekton-robot tekton-robot requested review from dibyom and jerop March 24, 2025 11:01
@tekton-robot tekton-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 24, 2025
@twoGiants twoGiants force-pushed the issues-8660-8486-update-setup-docs-and-remove-misleading-comment-in-makefile branch from 2798bd7 to 497bc61 Compare March 24, 2025 11:01
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 tektoncd#8660
Issue tektoncd#8486

Signed-off-by: Stanislav Jakuschevskij <[email protected]>
@twoGiants twoGiants force-pushed the issues-8660-8486-update-setup-docs-and-remove-misleading-comment-in-makefile branch from 497bc61 to e914d46 Compare March 24, 2025 11:28
@tekton-robot tekton-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Mar 24, 2025
@vdemeester vdemeester removed the kind/bug Categorizes issue or PR as related to a bug. label Mar 24, 2025
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Mar 24, 2025
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@twoGiants twoGiants changed the title docs: fix wrong entry in development documentation Fix wrong entry in development documentation and other minor documentation corrections. Mar 24, 2025
@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 24, 2025
@afrittoli
Copy link
Member

@twoGiants Thanks for this!
The check-pr-has-kind-label CI job expects a single kind label, so it fails now.

About the kind.local registry setting, it is supported by ko to inject the images directly into the kind cluster.
It used to work, do you have details on the failure you're getting?

@tekton-robot tekton-robot merged commit 3aba3cb into tektoncd:main Mar 24, 2025
20 checks passed
@twoGiants
Copy link
Contributor Author

@twoGiants Thanks for this! The check-pr-has-kind-label CI job expects a single kind label, so it fails now.

Thanks, I removed the "documentation" label.

About the kind.local registry setting, it is supported by ko to inject the images directly into the kind cluster. It used to work, do you have details on the failure you're getting?

Yes, I created a small issue #8660. The error is:

Error: error processing import paths in "config/webhook.yaml": error resolving image references: no nodes found for cluster "kind"

I am investigating a bit further. I will get back at you here.

@twoGiants
Copy link
Contributor Author

@afrittoli I found the issue with kind.local. It is not working if one starts the cluster with the tekton_in_kind.sh plumbing script which I did. In the plumbing script a local registry is deployed outside kind and the configuration is patched to use it. ko must then be configured to use that registry because that is what kind uses.

But when I start the kind cluster without the local registry kind.local for ko works. I will open another tiny PR with the updated documentation which mentions this.

Thanks for pointing that out @afrittoli, it helped me to dig a bit deeper and find the real issue!

@twoGiants
Copy link
Contributor Author

@afrittoli updated the documentation in this tiny PR #8662. Thank you for the review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesnt merit a release note. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
Status: Done
4 participants