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

Inconsistency between README instructions and Makefile output #86

Open
omerap12 opened this issue Sep 24, 2024 · 4 comments
Open

Inconsistency between README instructions and Makefile output #86

omerap12 opened this issue Sep 24, 2024 · 4 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug.

Comments

@omerap12
Copy link
Member

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.

@omerap12 omerap12 added the kind/bug Categorizes issue or PR as related to a bug. label Sep 24, 2024
@omerap12
Copy link
Member Author

/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@omerap12:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue

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 good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Sep 24, 2024
jayeshmahajan added a commit to jayeshmahajan/secrets-store-sync-controller that referenced this issue Sep 27, 2024
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.
@jayeshmahajan
Copy link

PR #87

@jayeshmahajan
Copy link

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

No branches or pull requests

3 participants