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.

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

doc: enhance the README.md to include development instructions. #154

Merged
merged 1 commit into from
Jul 15, 2024
Merged

doc: enhance the README.md to include development instructions. #154

merged 1 commit into from
Jul 15, 2024

Conversation

nestoracunablanco
Copy link
Contributor

What this PR does / why we need it:
This saves time for new developers when onboarding to the project

Which issue(s) this PR fixes:

Fixes #152

Special notes for your reviewer:

Release note:

@kubevirt-bot kubevirt-bot added the release-note-none Denotes a PR that doesn't merit a release note. label Jul 11, 2024
@kubevirt-bot kubevirt-bot added the dco-signoff: yes Indicates the PR's author has DCO signed all their commits. label Jul 11, 2024
@openshift-ci OpenShift CI
Copy link

openshift-ci bot commented Jul 11, 2024

Hi @nestoracunablanco. Thanks for your PR.

I'm waiting for a kubevirt 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-sigs/prow repository.

@openshift-ci openshift-ci bot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Jul 11, 2024
akrejcir
akrejcir reviewed Jul 15, 2024
View reviewed changes
README.md Outdated
@@ -36,3 +36,6 @@ kubectl create rolebinding "${ROLE_BINDING_NAME}" --clusterrole="token.kubevirt.
# Bind ClusterRole to a ServiceAccount
kubectl create rolebinding "${ROLE_BINDING_NAME}" --clusterrole="token.kubevirt.io:generate" --serviceaccount="${SERVICE_ACCOUNT_NAME}"
```

## Development
To develop locally, set the environment variables IMG_REPOSITORY and IMG_TAG (or the variable IMG) to your development repository. Then run make build-container push-container to build the current code and push it into your development repository. Finally, run make deploy to install the development version.
Copy link
Collaborator

@akrejcir akrejcir Jul 15, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Thanks! Can you add formatting back ticks around variables and commands? Like this:

Suggested change
To develop locally, set the environment variables IMG_REPOSITORY and IMG_TAG (or the variable IMG) to your development repository. Then run make build-container push-container to build the current code and push it into your development repository. Finally, run make deploy to install the development version.
To develop locally, set the environment variables `IMG_REPOSITORY` and `IMG_TAG` (or the variable `IMG`) to your development repository. Then run `make build-container push-container` to build the current code and push it into your development repository. Finally, run `make deploy` to install the development version.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, thank you!

@nestoracunablanco
doc: enhance the README.md to include development instructions.
554d4a0 
Signed-off-by: Nestor Acuna-Blanco <nestor.acuna@ibm.com>
@akrejcir
Copy link
Collaborator

/ok-to-test
/lgtm
/approve

@openshift-ci openshift-ci bot 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 Jul 15, 2024
@kubevirt-bot kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 15, 2024
@kubevirt-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: akrejcir

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

@kubevirt-bot kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 15, 2024
@kubevirt-bot kubevirt-bot merged commit 1ced42c into kubevirt:main Jul 15, 2024
3 checks passed
@nestoracunablanco nestoracunablanco deleted the doc/development branch July 15, 2024 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akrejcir akrejcir akrejcir left review comments

@lyarwood lyarwood Awaiting requested review from lyarwood

Assignees

@akrejcir akrejcir

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. lgtm 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/XS
Projects
None yet
Milestone
No milestone
3 participants
@nestoracunablanco @akrejcir @kubevirt-bot