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

Command Summaries #1179

Merged
merged 224 commits into from
May 22, 2024
Merged

Command Summaries #1179

merged 224 commits into from
May 22, 2024

Conversation

EyalDelarea
Copy link
Contributor

@EyalDelarea EyalDelarea commented May 1, 2024

  • All tests passed. If this feature is not already covered by the tests, I added new tests.
  • All static analysis checks passed.
  • This pull request is on the dev branch.
  • I used gofmt for formatting the code before submitting the pull request.

Command Summaries

Allows to record data of CLI commands results to the filesystem, and create markdown files based on the files.

How to implement

In order to use the command summaries feature you'll have to implement the function's interface

type CommandSummaryInterface interface {
   GenerateMarkdownFromFiles(dataFilePaths []string) (finalMarkdown string, err error)
}

Which will take a slice of full file paths and will need to generate a markdown for it.

How does it work?

Each time you have a command results you'd like to save, you create a markdown.
This action will save the current result to the file system, and will be reposbile for creating
a markdown string, based on ALL the files exsiting inside the file system.

The filesystem will look like this:
image

omerzi and others added 30 commits April 5, 2023 10:15
* Improve UI for scan command (jfrog#706)

* Upgrade go version in go.mod to 1.20 (jfrog#732)

* Fix lint issues found (jfrog#733)

* Config transfer - ensure target not older than source (jfrog#721)

* Update tests environment - nuget and dotnet to version 6  (jfrog#734)

* Flatten audit graph (jfrog#736)

* Use gradle-dep-tree with Audit (jfrog#719)

---------

Co-authored-by: Sara Omari <114062096+sarao1310@users.noreply.github.com>
Co-authored-by: Eyal Ben Moshe <eyalbenmoshe@jfrog.com>
Co-authored-by: Michael Sverdlov <sverdlov93@gmail.com>
Co-authored-by: Yahav Itzhak <yahavi@users.noreply.github.com>
# Conflicts:
#	.github/workflows/analysis.yml
#	go.mod
#	go.sum
#	xray/audit/java/gradle.go
#	xray/commands/audit/generic/auditmanager.go
Copy link
Member

@yahavi yahavi left a comment

Choose a reason for hiding this comment

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

Well done @EyalDelarea!
Please consider my inline comments.

artifactory/commands/buildinfo/publish.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
artifactory/utils/filetree.go Outdated Show resolved Hide resolved
artifactory/utils/filetree.go Outdated Show resolved Hide resolved
commandsummary/commandsummary_test.go Outdated Show resolved Hide resolved
commandsummary/commandsummary_test.go Outdated Show resolved Hide resolved
commandsummary/commandsummary_test.go Outdated Show resolved Hide resolved
artifactory/commands/generic/upload.go Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
commandsummary/commandsummary.go Outdated Show resolved Hide resolved
Copy link
Contributor

👍 Frogbot scanned this pull request and did not find any new security issues.


@EyalDelarea EyalDelarea merged commit 44e989e into jfrog:dev May 22, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature Automatically generated release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

10 participants