Skip to content

quality-of-life: Improve local development tooling #270

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sebrandon1
Copy link
Member

This PR updates the Makefile with .PHONY targets, better error handling for deploy/undeploy, and adds README.md sections on cleanup, tests, and linting.

Makefile Enhancements:

  • Added .PHONY declarations to multiple targets (local-run, build-operator, build, run, image-build, image-push, deploy, undeploy, test-e2e-wait-for-stable-state, test-e2e-debug-cluster, lint) to ensure proper execution and avoid conflicts with files of the same name. [1] [2] [3] [4] [5]

  • Improved the deploy target to create the cert-manager-operator namespace if it does not exist, ensuring smoother deployment.

  • Enhanced the undeploy target to ignore not-found errors when deleting resources, improving robustness.

  • Added a check in the lint target to ensure golangci-lint is installed before running, providing a clearer error message if it is missing.

Documentation Updates:

  • Added a "Cleaning up the deployment" section in README.md, explaining how to remove the Cert Manager Operator and its associated resources using make undeploy.

  • Introduced a "Running tests locally" section in README.md, detailing how to execute unit tests and generate a coverage report.

  • Added a "Linting the code" section in README.md, describing how to run make lint to check for linting issues using golangci-lint.

@openshift-ci openshift-ci bot requested review from deads2k and TrilokGeer May 5, 2025 15:51
Copy link
Contributor

openshift-ci bot commented May 5, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: sebrandon1
Once this PR has been reviewed and has the lgtm label, please assign trilokgeer 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

Copy link
Contributor

openshift-ci bot commented May 5, 2025

@sebrandon1: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-operator-tech-preview 6f8a1be link false /test e2e-operator-tech-preview

Full PR test history. Your PR dashboard.

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-sigs/prow repository. I understand the commands that are listed here.

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