Skip to content

Conversation

@leandroberetta
Copy link
Contributor

@leandroberetta leandroberetta commented Nov 3, 2025

Description

This PR adds Claude commands to streamline the development workflow for NetObserv contributors.

Commands Added

/setup-dev-env - Setup NetObserv Development Environment

Sets up a complete development environment with interactive configuration:

  • Prompts for platform selection (OpenShift or Kubernetes)
  • Asks about custom images vs defaults
  • Deploys the operator with proper configuration
  • Deploys Loki and sample FlowCollector CR
  • Verifies the deployment

Usage: Ask Claude "Setup NetObserv Development Environment" or use /setup-dev-env

/debug-operator - Debug NetObserv Operator Locally

Prepares the environment for local debugging with multiple debugging options:

  • Scales down in-cluster operator
  • Removes validating webhook
  • Prompts for debugging method (go run, delve interactive, or delve headless + VSCode)
  • Provides guidance for setting breakpoints in the FlowCollector reconciler
  • Includes cleanup instructions

Usage: Ask Claude "Debug NetObserv Operator Locally" or use /debug-operator

Key Features

  • Interactive Configuration: Commands use Claude's AskUserQuestion tool to gather user
    preferences
  • Multiple Debugging Options: Supports different workflows (simple execution, terminal
    debugging, VSCode debugging)
  • Clear Prerequisites: /debug-operator requires /setup-dev-env to be run first
  • Cleanup Instructions: Both commands include cleanup steps
  • VSCode Integration: Added .vscode/launch.json for seamless Delve debugging

Benefits

  • Reduces onboarding time for new contributors
  • Standardizes development environment setup
  • Simplifies local debugging workflow
  • Eliminates the need to remember complex command sequences

Dependencies

n/a

Checklist

If you are not familiar with our processes or don't know what to answer in the list below, let us know in a comment: the maintainers will take care of that.

  • Is this PR backed with a JIRA ticket? If so, make sure it is written as a title prefix (in general, PRs affecting the NetObserv/Network Observability product should be backed with a JIRA ticket - especially if they bring user facing changes).
  • Does this PR require product documentation?
    • If so, make sure the JIRA epic is labeled with "documentation" and provides a description relevant for doc writers, such as use cases or scenarios. Any required step to activate or configure the feature should be documented there, such as new CRD knobs.
  • Does this PR require a product release notes entry?
    • If so, fill in "Release Note Text" in the JIRA.
  • Is there anything else the QE team should know before testing? E.g: configuration changes, environment setup, etc.
    • If so, make sure it is described in the JIRA ticket.
  • QE requirements (check 1 from the list):
    • Standard QE validation, with pre-merge tests unless stated otherwise.
    • Regression tests only (e.g. refactoring with no user-facing change).
    • No QE (e.g. trivial change with high reviewer's confidence, or per agreement with the QE team).

@leandroberetta leandroberetta self-assigned this Nov 3, 2025
@openshift-ci
Copy link

openshift-ci bot commented Nov 3, 2025

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@codecov
Copy link

codecov bot commented Nov 3, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.41%. Comparing base (0e91945) to head (70ab9b3).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2128      +/-   ##
==========================================
+ Coverage   73.27%   73.41%   +0.13%     
==========================================
  Files          82       82              
  Lines        9339     9339              
==========================================
+ Hits         6843     6856      +13     
+ Misses       2073     2066       -7     
+ Partials      423      417       -6     
Flag Coverage Δ
unittests 73.41% <ø> (+0.13%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 5 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@openshift-ci
Copy link

openshift-ci bot commented Dec 4, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign jotak for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found 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

@leandroberetta leandroberetta force-pushed the dev-env-claude-commands branch from 94c0739 to 70ab9b3 Compare December 4, 2025 19:41
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.

1 participant