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

[Request] Makefile should have short summaries for targets #634

Closed
tthvo opened this issue Sep 25, 2023 · 7 comments · Fixed by #637
Closed

[Request] Makefile should have short summaries for targets #634

tthvo opened this issue Sep 25, 2023 · 7 comments · Fixed by #637
Assignees
Labels
feat New feature or request good first issue Good for newcomers

Comments

@tthvo
Copy link
Member

tthvo commented Sep 25, 2023

Describe the feature

This would be helpful to contributors to not have to check the Makefile:

$ make help
Usage:
  make <target>
  help             Display this help.
  oci-buildx       Build OCI image for the manager for cross-platform support
  operator-sdk     Download operator-sdk locally if necessary.

Anything other information?

Operator-sdk scaffold sets this up so we can sync with them.

https://github.com/operator-framework/operator-sdk/blob/e67da35ef4fff3e471a208904b2a142b27ae32b1/testdata/go/v3/memcached-operator/Makefile#L86

Each target needs trailing comments on target definition line, for example:

https://github.com/operator-framework/operator-sdk/blob/e67da35ef4fff3e471a208904b2a142b27ae32b1/testdata/go/v3/memcached-operator/Makefile#L93

@tthvo tthvo added good first issue Good for newcomers feat New feature or request labels Sep 25, 2023
@pektezol
Copy link
Contributor

Do you only need this for oci-buildx and operator-sdk or all targets?

Also I couldn't see a operator-sdk target, am I looking wrong

@tthvo
Copy link
Member Author

tthvo commented Sep 27, 2023

Hi @pektezol, we will need this for all targets. The operator-sdk is not yet available on main. I took the example from #629.

@pektezol
Copy link
Contributor

Sounds good, @tthvo ! I would like to help with this sometime today.

@tthvo
Copy link
Member Author

tthvo commented Sep 27, 2023

Thanks!! Appreciate that!

@pektezol
Copy link
Contributor

@tthvo is it expected of me to write new summaries for targets that don't have them?

@tthvo
Copy link
Member Author

tthvo commented Sep 27, 2023

That would be awesome! But pls let me know if you need help.

@pektezol
Copy link
Contributor

Let me know if it needs adjusting, since I'm new to this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat New feature or request good first issue Good for newcomers
Projects
No open projects
Status: Done
2 participants