doc : add ginkgo prerequisite and running tests section #1570
Conversation
Add ginkgo to the prerequisites list as it's required for running tests locally. Also add a new \"Running Tests\" section that documents: - How to install ginkgo - How to ensure ginkgo is in PATH - How to run tests with make test - Note about ginkgo vs go test fallback behavior This addresses the missing documentation about test requirements for local development. Signed-off-by: Rohan Kumar <rohaan@redhat.com>
rohanKanojia
requested review from
akurinnoy,
dkwon17 and
ibuziuk
as code owners
|
@rohanKanojia: The following test failed, say
Full PR test history. Your PR dashboard. DetailsInstructions 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. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: akurinnoy, rohanKanojia The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
2 participants
What does this PR do?
Add ginkgo to the prerequisites list as it's required for running tests locally. Also add a new "Running Tests" section that documents:
This addresses the missing documentation about test requirements for local development.
What issues does this PR fix or reference?
This PR addresses a gap in the documentation that was discovered during an internal slack discussion. The Prerequisites section mentioned various tools needed for development, but omitted
ginkgo, which is required for the full test suite to run properly.Is it tested? How?
N/A
PR Checklist
/test v8-devworkspace-operator-e2e, v8-che-happy-pathto trigger)v8-devworkspace-operator-e2e: DevWorkspace e2e testv8-che-happy-path: Happy path for verification integration with Che