Skip to content

Document controller debugging configuration. #8881

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jul 22, 2025
Merged

Document controller debugging configuration. #8881

merged 1 commit into from
Jul 22, 2025

Conversation

@twoGiants
Copy link
Member

@twoGiants twoGiants commented Jul 12, 2025 •
edited
Loading

Changes

Add controller debugging configuration to developer docs.

Closes #8876.

/kind docs
/kind chores

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

Developer documentation in `DEVELOPMENT.md` contains a "Debugging" section explaining how to setup VSCode for debugging Tekton controllers running in a k8 cluster.

@tekton-robot
Copy link
Collaborator

tekton-robot commented Jul 12, 2025

@twoGiants: The label(s) kind/docs, kind/chores cannot be applied, because the repository doesn't have them.

In response to this:

Changes

Add controller debugging configuration to developer docs.

Issue #8876.

/kind docs
/kind chores

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

Developer documentation in `DEVELOPMENT.md` contains a "Debugging" section explaining how to setup VSCode for debugging Tekton controllers running in a k8 cluster.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@tekton-robot tekton-robot added the release-note Denotes a PR that will be considered when it comes time to generate release notes. label Jul 12, 2025
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jul 12, 2025
@tekton-robot tekton-robot requested review from dibyom and jerop July 12, 2025 16:52
@twoGiants
Copy link
Member Author

twoGiants commented Jul 12, 2025

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 12, 2025
@twoGiants
Copy link
Member Author

twoGiants commented Jul 12, 2025

/kind misc

@tekton-robot tekton-robot added the kind/misc Categorizes issue or PR as a miscellaneuous one. label Jul 12, 2025
@twoGiants
Copy link
Member Author

twoGiants commented Jul 12, 2025

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

tekton-robot commented Jul 12, 2025

@twoGiants: No presubmit jobs available for tektoncd/pipeline@main

In response to this:

/test check-pr-has-kind-label

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@twoGiants
Copy link
Member Author

twoGiants commented Jul 12, 2025 •
edited
Loading

/cc @afrittoli I finally managed to setup controller debugging 😺 🥲

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 16, 2025
@twoGiants
Copy link
Member Author

twoGiants commented Jul 16, 2025

/retest

afrittoli
afrittoli reviewed Jul 16, 2025
View reviewed changes
Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

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

/approve
/lgtm

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

tekton-robot commented Jul 16, 2025

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: afrittoli, 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:
  • OWNERS [afrittoli,vdemeester]

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

@twoGiants
docs: add debugging controllers documentation
83e7f71 
Issue tektoncd#8876.

Signed-off-by: Stanislav Jakuschevskij <[email protected]>
@twoGiants twoGiants force-pushed the issue-8879-add-debugging-setup-docs branch from 94e72ea to 83e7f71 Compare July 17, 2025 14:26
@tekton-robot tekton-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 17, 2025
@twoGiants
Copy link
Member Author

twoGiants commented Jul 17, 2025

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

tekton-robot commented Jul 17, 2025

@twoGiants: No presubmit jobs available for tektoncd/pipeline@main

In response to this:

/test check-pr-has-kind-label

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@twoGiants
Copy link
Member Author

twoGiants commented Jul 17, 2025

/kind documentation

@afrittoli afrittoli removed the kind/misc Categorizes issue or PR as a miscellaneuous one. label Jul 17, 2025
@afrittoli
Copy link
Member

afrittoli commented Jul 22, 2025

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 22, 2025
@tekton-robot tekton-robot merged commit ba51551 into tektoncd:main Jul 22, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@afrittoli afrittoli afrittoli left review comments

@vdemeester vdemeester vdemeester approved these changes

@dibyom dibyom Awaiting requested review from dibyom

@jerop jerop Awaiting requested review from jerop

Assignees

@afrittoli afrittoli

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 Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

Tekton Community Roadmap
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Configure delve debugger for Tekton controller in VSCode.

4 participants

@twoGiants @tekton-robot @afrittoli @vdemeester