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

Update README.md Fixing issue # https://github.com/kubernetes-sigs/secrets-store-sync-controller/issues/86 #87

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jayeshmahajan
Copy link

@jayeshmahajan jayeshmahajan commented Sep 27, 2024

Fixing issue # #86

As per

https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L172

https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L106-L110

https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L53C1-L54

The README.md file provides instructions for deploying the controller (https://github.com/kubernetes-sigs/secrets-store-sync-controller?tab=readme-ov-file#deploy-the-controller). However, there are discrepancies between the instructions and the actual outcomes of the commands.

Specifically, when executing the command: VERSION=e2e make docker-build The resulting Docker image is named controller:e2e instead of secrets-store-sync-controller:e2e as stated in the documentation. This inconsistency between the documentation and the actual behavior may lead to confusion for users attempting to deploy the controller.

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, using fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when the PR gets merged):
Fixes #

Special notes for your reviewer:

TODOs:

  • squashed commits
  • includes documentation
  • adds unit tests

Fixins issue # kubernetes-sigs#86

As per 
https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L53C1-L54

https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L172

https://github.com/kubernetes-sigs/secrets-store-sync-controller/blob/main/Makefile#L106-L110

The README.md file provides instructions for deploying the controller (https://github.com/kubernetes-sigs/secrets-store-sync-controller?tab=readme-ov-file#deploy-the-controller). However, there are discrepancies between the instructions and the actual outcomes of the commands.

Specifically, when executing the command: VERSION=e2e make docker-build
The resulting Docker image is named controller:e2e instead of secrets-store-sync-controller:e2e as stated in the documentation.
This inconsistency between the documentation and the actual behavior may lead to confusion for users attempting to deploy the controller.
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jayeshmahajan
Once this PR has been reviewed and has the lgtm label, please assign enj for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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 cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 27, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @jayeshmahajan!

It looks like this is your first PR to kubernetes-sigs/secrets-store-sync-controller 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/secrets-store-sync-controller has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @jayeshmahajan. 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-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Sep 27, 2024
@omerap12
Copy link
Member

/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 Sep 27, 2024
@jayeshmahajan
Copy link
Author

/retest

@jayeshmahajan
Copy link
Author

jayeshmahajan commented Sep 27, 2024

I'm new here and this is my first PR. It seems workflows are either stuck or super slow from last few hours. How can I move forward here @omerap12 @aramase

@aramase
Copy link
Member

aramase commented Oct 2, 2024

/assign @nilekhc

@jayeshmahajan
Copy link
Author

@nilekhc - Let me know if you need anything from me here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants