search

kubernetes-sigs / cluster-api-provider-gcp

The GCP provider implementation for Cluster API
Apache License 2.0
178 stars 194 forks source link

Improve documentation on E2E tests #1080

Closed salasberryfin closed 2 months ago

salasberryfin commented 9 months ago

/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.

professorabhay commented 9 months ago

Hey @salasberryfin, Can I do this?

salasberryfin commented 9 months ago

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 commented 7 months ago

/assign

k8s-triage-robot commented 4 months ago

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

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

You can:

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

/lifecycle stale

k8s-triage-robot commented 3 months ago

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:

You can:

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

/lifecycle rotten

k8s-triage-robot commented 2 months ago

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

This bot triages issues according to the following rules:

You can:

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

/close not-planned

k8s-ci-robot commented 2 months ago

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to [this](https://github.com/kubernetes-sigs/cluster-api-provider-gcp/issues/1080#issuecomment-2194076685): >The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. > >This bot triages 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: >- Reopen this issue with `/reopen` >- Mark this issue as fresh with `/remove-lifecycle rotten` >- Offer to help out with [Issue Triage][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close not-planned > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.