Skip to content

Update local development instructions #1081

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Nov 17, 2022
Merged

Update local development instructions #1081

merged 4 commits into from
Nov 17, 2022

Conversation

judemars
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, hit enter to put that in a new line, and remove leading whitespaces from that line:

/kind api-change
/kind bug
/kind cleanup
/kind design

/kind documentation

/kind failing-test
/kind feature
/kind flake

What this PR does / why we need it:

Updates local development documentation with more detail + adds new needed role for e2e testing.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

NONE

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Nov 16, 2022
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 16, 2022
@k8s-ci-robot
Copy link
Contributor

Hi @judemars. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Nov 16, 2022
@judemars judemars changed the title update local development instructions Update local development instructions Nov 16, 2022
mattcary
mattcary reviewed Nov 16, 2022
View reviewed changes
docs/local-development.md Outdated
### Sanity Tests
> **_NOTE:_** Sanity tests are currently failing, tracked by go/pdcsi-oss-driver/issues/990.

Unit tests can be run from VS Code, etc directly or via the cmd line:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/Unit/Sanity/?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Woops, fixed! Thanks

@mauriciopoppe
Copy link
Member

There's also https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver/blob/master/docs/kubernetes/development.md

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 17, 2022
@judemars
Copy link
Contributor Author

@mauriciopoppe is the request to combine them?

mauriciopoppe
mauriciopoppe reviewed Nov 17, 2022
View reviewed changes
Copy link
Member

@mauriciopoppe mauriciopoppe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just wanted to point out that there is another set of docs to install the driver on an existing k8s cluster. I haven't read what ./test/run-e2e-local.sh but I usually install the driver and then run the e2e tests as different steps

docs/local-development.md Outdated
$ ./test/run-e2e-local.sh
```

Running Sanity Tests:
### Sanity Tests
> **_NOTE:_** Sanity tests are currently failing, tracked by go/pdcsi-oss-driver/issues/990.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This link only works internally

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great point, fixed! Thanks

@judemars
Copy link
Contributor Author

judemars commented Nov 17, 2022 •
edited
Loading

Alrighty @mauriciopoppe I combined the development guides, I think it makes sense to have the testing instructions after the installation instructions. Lmk what you think

@mauriciopoppe
Copy link
Member

cool, thanks for merging the docs

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 17, 2022
@mattcary
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: judemars, mattcary

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 17, 2022
@k8s-ci-robot k8s-ci-robot merged commit 10ed92e into kubernetes-sigs:master Nov 17, 2022
@judemars judemars mentioned this pull request Nov 23, 2022
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mauriciopoppe mauriciopoppe mauriciopoppe left review comments

@mattcary mattcary mattcary left review comments

@amacaskill amacaskill Awaiting requested review from amacaskill

@msau42 msau42 Awaiting requested review from msau42

Assignees

@mauriciopoppe mauriciopoppe

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@judemars @k8s-ci-robot @mauriciopoppe @mattcary