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

Add to the PROJECT file the CLI tag version used to do the scaffold #3229

Closed
camilamacedo86 opened this issue Feb 16, 2023 · 10 comments
Closed
Assignees
Labels
kind/feature Categorizes issue or PR as related to a new feature.

Comments

@camilamacedo86
Copy link
Member

What do you want to happen?

The idea of this task is for we start to track in the PROJECT file what was the Kubebuilder version used to do the scaffold so that for proposed features like #3221 or for support purpose for example this info can be helpful in the long term.

Extra Labels

No response

@camilamacedo86 camilamacedo86 added the kind/feature Categorizes issue or PR as related to a new feature. label Feb 16, 2023
@camilamacedo86
Copy link
Member Author

@yashsingh74 this one might be a good one for you. You need to ensure that we will have in the Project file (config) this new field and that when we init a project, that will be filled with the kubebuilder version info.

@yashsingh74
Copy link
Member

Sure, will look into this.
/assign

@ashutosh887
Copy link
Contributor

@camilamacedo86 Let me work on this now if it's still needed
/assign

@camilamacedo86 camilamacedo86 added help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. and removed help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels May 1, 2023
@ashutosh887
Copy link
Contributor

Yes I'm willing to work on this @camilamacedo86

Can you guide me a bit how to approach this?

@yashsingh74
Copy link
Member

@ashutosh887 you can work on this.

@yashsingh74 yashsingh74 removed their assignment May 2, 2023
@yyy1000
Copy link
Member

yyy1000 commented May 4, 2023

/assign

@ashutosh887
Copy link
Contributor

You may continue @yyy1000 🙂

@camilamacedo86
Copy link
Member Author

I want to clarify that I identified this issue based on a request made by a community member in the Slack channel when we shared the proposed solution for a command tool that could re-scaffold projects. The member suggested using the tool for a three-way scaffold merge to automate the process as a subsequent step in the implementation.

It was flagged as a good first issue, as it seemed to be a change that new contributors could handle.

However, after examining the draft proposal and giving it more thought, I'm starting to think that we should not pursue this idea, at least for now. Here's why:

  • If we track the CLI version used to scaffold the project, it doesn't necessarily have to be the same version used for plugin scaffolding. This would require tracking on a per-plugin basis.
  • Managing multiple different versions used for scaffolding could complicate the future command tool implementation.
  • Addressing this issue now might not add value, as the resulting values might not be useful and could lead to premature optimization.

Given these concerns, I would like to mark this issue as deferred and allow us to reconsider how we can move forward and improve the proposed idea of providing a helper to re-scaffold projects once it's completed and we have the opportunity to test it.

@yyy1000 your PR: #3387 was helpful for us better think about this one. Do you mind if we close both as deferred?

@yyy1000
Copy link
Member

yyy1000 commented May 7, 2023

It's OK to defer these.

@camilamacedo86
Copy link
Member Author

Great, I am closing this one based on the comment #3229 (comment), but we can look into it in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants