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

[48h Knative] Command Usage Example Integration Testing POC #1895

Closed
4 tasks done
Cali0707 opened this issue Nov 17, 2023 · 4 comments
Closed
4 tasks done

[48h Knative] Command Usage Example Integration Testing POC #1895

Cali0707 opened this issue Nov 17, 2023 · 4 comments
Assignees
Labels
knative48h Issue selected for the "48h Knative" hackathon lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.

Comments

@Cali0707
Copy link
Member

Cali0707 commented Nov 17, 2023

👋 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—a 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 with kn.

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

  • Added to Project Board
  • Proposal Reviewed
  • Assigned a Mentor
  • Expected Outcome define
@Cali0707 Cali0707 added the knative48h Issue selected for the "48h Knative" hackathon label Nov 17, 2023
@rhuss
Copy link
Contributor

rhuss commented Feb 21, 2024

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.

Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions 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
@rhuss
Copy link
Contributor

rhuss commented May 27, 2024

/remove-lifecycle stale

@knative-prow 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
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 26, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
knative48h Issue selected for the "48h Knative" hackathon lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale.
Projects
Status: Done
Development

No branches or pull requests

2 participants