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

chore(build): add short summaries to targets #636

Closed
wants to merge 0 commits into from
Closed

chore(build): add short summaries to targets #636

wants to merge 0 commits into from

Conversation

pektezol
Copy link
Contributor

Welcome to Cryostat! 👋

Before contributing, make sure you have:

  • Read the contributing guidelines
  • Linked a relevant issue which this PR resolves
  • Linked any other relevant issues, PR's, or documentation, if any
  • Resolved all conflicts, if any
  • Rebased your branch PR on top of the latest upstream main branch
  • Attached at least one of the following labels to the PR: [chore, ci, docs, feat, fix, test]
  • Signed all commits: git commit -S -m "YOUR_COMMIT_MESSAGE"

Fixes: #634

Description of the change:

This change will make it easier for people to see Makefile targets clearly, with topic handles and short summaries using make help. Let me know if it needs readjusting in any way.

Motivation for the change:

To contribute to an open-source project.

How to manually test:

  1. Execute make help
  2. ???
  3. Profit

@andrewazores andrewazores added chore Refactor, rename, cleanup, etc. build labels Sep 28, 2023
@andrewazores
Copy link
Member

2023-09-28T15:24:25,329101881-04:00

That's very cool.

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Copy link
Member

@andrewazores andrewazores left a comment

Choose a reason for hiding this comment

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

Nicely done! Just a few minor suggestions to rephrase some of the descriptions, but overall this is great.

@pektezol pektezol changed the title feat(build): add short summaries to targets chore(build): add short summaries to targets Sep 28, 2023
@tthvo tthvo requested a review from ebaron September 28, 2023 20:23
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@pektezol
Copy link
Contributor Author

I guess that should be everything? Thanks for the reviews ^^

Makefile Outdated Show resolved Hide resolved
@pektezol
Copy link
Contributor Author

I guess that should be everything? Thanks for the reviews ^^

Guess not lol

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Copy link
Member

@tthvo tthvo left a comment

Choose a reason for hiding this comment

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

Looks good to me! Any other comments @andrewazores @ebaron?

Makefile Outdated Show resolved Hide resolved
@andrewazores
Copy link
Member

Uhh... what. I guess that's a failure in my rebase attempt.

@andrewazores
Copy link
Member

@pektezol just force-push from your local main on your computer back to your remote main branch

@andrewazores
Copy link
Member

Or at worst, the Makefile patch in the force-push comparison is still there and contains basically the reverse patch needed:

https://github.com/cryostatio/cryostat-operator/compare/c16c7f0e74b6cf127df635285fb8068689d5d1ab..5c3769f5a2823847214528fb655b297d688dac14#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52

@tthvo
Copy link
Member

tthvo commented Sep 29, 2023

Ahh that must something troublesome to do with pushing to fork main? We can move work to #637 then. Contributions are still recorded for @pektezol anyway^^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build chore Refactor, rename, cleanup, etc.
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Request] Makefile should have short summaries for targets
3 participants