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

📖 Add dev doc on setting up live debugging #1653

Merged
merged 1 commit into from
Feb 14, 2025

Conversation

trgeiger
Copy link
Contributor

Adds a short doc on how to set up breakpoints with VSCode through Tilt. This isn't in the official website documentation, just in the /dev folder where we have an existing tutorial on setting up a kind registry with podman on mac.

Description

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

@trgeiger trgeiger requested a review from a team as a code owner January 27, 2025 21:39
Copy link

netlify bot commented Jan 27, 2025

Deploy Preview for olmv1 ready!

Name Link
🔨 Latest commit 52f3ba1
🔍 Latest deploy log https://app.netlify.com/sites/olmv1/deploys/67af9990f7debe0008346c3d
😎 Deploy Preview https://deploy-preview-1653--olmv1.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@trgeiger trgeiger marked this pull request as draft January 27, 2025 21:40
@openshift-ci openshift-ci bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 27, 2025
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.34%. Comparing base (7146a7a) to head (52f3ba1).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1653   +/-   ##
=======================================
  Coverage   68.34%   68.34%           
=======================================
  Files          63       63           
  Lines        5117     5117           
=======================================
  Hits         3497     3497           
  Misses       1390     1390           
  Partials      230      230           
Flag Coverage Δ
e2e 51.62% <ø> (ø)
unit 55.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@trgeiger trgeiger marked this pull request as ready for review January 28, 2025 17:56
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 28, 2025

`sudo vi /etc/containers/registries.conf.d/100-kind.conf`
If your host is a Mac, first run:
Copy link
Contributor

Choose a reason for hiding this comment

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

Since you're broadening the doc scope beyond just macs and into linux processes, it would be nice to have a consistent approach to "{{ if $THISPLATFORM }} dostuff {{ endif }}".
I'll take a longer look later, but it gets a bit confusing later in this doc where it suggests that a mac could run systemctl. 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

hehe yeah, good catch. i mean if there's enough differences we could just have distinct docs/tutorials for diff OSes

perdasilva
perdasilva previously approved these changes Jan 30, 2025
Copy link
Contributor

@perdasilva perdasilva left a comment

Choose a reason for hiding this comment

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

Nice one! Thank you ^^

Adds a short doc on how to set up breakpoints with VSCode through Tilt.
Also expands on the existing podman local environment document.

Signed-off-by: Tayler Geiger <[email protected]>
@grokspawn grokspawn enabled auto-merge February 14, 2025 19:33
@grokspawn grokspawn added this pull request to the merge queue Feb 14, 2025
Merged via the queue into operator-framework:main with commit 7f00b13 Feb 14, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants