jfrog / jfrog-cli-core

Apache License 2.0
32 stars 55 forks source link

Command Summaries #1179

Closed EyalDelarea closed 2 months ago

EyalDelarea commented 2 months ago

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

github-actions[bot] commented 2 months ago
[![👍 Frogbot scanned this pull request and did not find any new security issues.](https://raw.githubusercontent.com/jfrog/frogbot/master/resources/v2/noVulnerabilityBannerPR.png)](https://docs.jfrog-applications.jfrog.io/jfrog-applications/frogbot)

[🐸 JFrog Frogbot](https://docs.jfrog-applications.jfrog.io/jfrog-applications/frogbot)