-
Notifications
You must be signed in to change notification settings - Fork 263
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
[48h Knative] Command Usage Example Integration Testing POC #1895
Labels
knative48h
Issue selected for the "48h Knative" hackathon
Comments
oops, just realized that we forgot to pick up that story in the 48h Knative Hackathon last December. Sorry for that, I still think this is a good story to implement. |
This issue is stale because it has been open for 90 days with no |
github-actions
bot
added
the
lifecycle/stale
Denotes an issue or PR has remained open with no activity and has become stale.
label
May 22, 2024
/remove-lifecycle stale |
knative-prow
bot
removed
the
lifecycle/stale
Denotes an issue or PR has remained open with no activity and has become stale.
label
May 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
馃憢 Hello awesome contributor!
Are you excited about Knative and open-source development? You're in the right place! This is a mini-project for the upcoming 48h Knative event鈥攁 48-hour hackathon designed to boost contributions to the Knative Client project. For more details, check out Issue #1842.
馃幆 Project Description
The Knative client has a help flag on it's commands that often prints example usages to the console. For example, the output of
kn broker create --help
will include multiple examples for how to create a broker withkn
.Unfortunately, these examples are not tested to always work, so there can be bugs where the example command no longer works (e.g. #1885).
There is an open issue to implement integration tests for all examples (#1889), and it has some initial thoughts on an approach. However, the extent of this project is to create a proof of concept implementation of how we can test all of the examples, by adding tests for the examples for one command.
馃専 Benefits
Often, the help text is how users learn how to us the knative client, so we should ensure that it is always up to date and working. This will ensure that it always is.
馃洜 Difficulty Level
Intermediate
馃懃 Recommended Team Size
1-3 people
馃帀 Expected Outcome
A proof of concept where all of the examples for one command have integration tests. This POC should work in a way where adding new examples to the command would require that those new examples have integration tests.
馃 Mentor
@Cali0707
馃摑 Additional Information
馃寪 Entrypoints
馃搵 Organizer Checklist
The text was updated successfully, but these errors were encountered: