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

Improve documentation on E2E tests #1080

Open
salasberryfin opened this issue Nov 16, 2023 · 5 comments
Open

Improve documentation on E2E tests #1080

salasberryfin opened this issue Nov 16, 2023 · 5 comments
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.

Comments

@salasberryfin
Copy link
Contributor

salasberryfin commented Nov 16, 2023

/kind documentation

Describe the solution you'd like
While working on #1053, I've encountered a few obstacles to run E2E tests locally and I haven't found the documentation to be very detailed on how E2E tests are actually structured and how to use them as a developer. Thanks to @richardcase, I've been able to identify a few things missing from my configuration but I think it would be great, especially for new or relatively new contributors, to have a nuanced, easy to follow documentation on how CAPG E2E tests are structured and how a user can leverage them to improve their development experience.

Anything else you would like to add:

This is the E2E section from the CAPZ book which can be used as a reference.

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 16, 2023
@professorabhay
Copy link

Hey @salasberryfin, Can I do this?

@salasberryfin
Copy link
Contributor Author

Hey @professorabhay, thanks for volunteering to work on this. It would be better to have confirmation from any of the cluster-api-gcp-maintainers @richardcase @cpanato @dims.

@salasberryfin
Copy link
Contributor Author

/assign

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle stale
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 28, 2024
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue as fresh with /remove-lifecycle rotten
  • Close this issue with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed.
Projects
None yet
Development

No branches or pull requests

4 participants