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

create detailed summary for every command when JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR is set #2820

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from

Conversation

ahippler
Copy link

@ahippler ahippler commented Jan 8, 2025

  • All tests have passed. If this feature is not already covered by the tests, new tests have been added.
  • The pull request is targeting the dev branch.
  • The code has been validated to compile successfully by running go vet ./....
  • The code has been formatted properly using go fmt ./....

Some commands use the cliutils.GetDetailedSummary which checks JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR but others only use the detailed-summary cli flag. This PR unifies this and uses cliutils.GetDetailedSummary for every command.

This will be useful for the github setup-jfrog-sli action to enable the summary on every command.

Copy link
Contributor

github-actions bot commented Jan 8, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@ahippler
Copy link
Author

ahippler commented Jan 8, 2025

I have read the CLA Document and I hereby sign the CLA

@EyalDelarea
Copy link
Contributor

Hey @ahippler,

Thank you for your contribution!

To add commands to the summary, you would need to record relevant data during the command's execution and implement functions to transform this data into markdown. Unfortunately, achieving this for every command with just a one-liner change isn’t feasible. Moreover, we aim to avoid summarizing every command, as doing so would dilute the purpose of having a concise and meaningful summary.

Could you elaborate on the specific use case you have in mind? I’d love to hear your thoughts!

If you're looking for more information on how to implement new command summaries, feel free to check out the documentation here.

Best regards,
Eyal

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants