commandsummary

Nov 4, 2024

Changes in this version

+ func CheckExtendedSummaryEntitled(serverUrl string) (bool, error)

Sep 4, 2024

Changes in this version

type IndexedFilesMap

+ func GetIndexedDataFilesPaths() (indexedFilePathsMap IndexedFilesMap, err error)

Aug 29, 2024

Changes in this version

+ const DataFileFormat

+ const NonScannedResult

+ const NoneScannedResult

+ const OutputDirName

+ const SarifFileFormat

+ var StaticMarkdownConfig = MarkdownConfig

+ func GenerateArtifactUrl(pathInRt string) string

+ func InitMarkdownGenerationValues(serverUrl string, platformMajorVersion int) (err error)

+ func ShouldRecordSummary() bool

+ func UnmarshalFromFilePath(dataFile string, target any) (err error)

+ func WrapCollapsableMarkdown(title, markdown string, headerSize int) string

+ type BuildInfoSummary struct

+ func (bis *BuildInfoSummary) GenerateMarkdownFromFiles(dataFilePaths []string) (finalMarkdown string, err error)

+ func (bis *BuildInfoSummary) GetSummaryTitle() string

+ type CommandSummary struct

+ func New(userImplementation CommandSummaryInterface, commandsName string) (cs *CommandSummary, err error)

+ func NewBuildInfoSummary() (*CommandSummary, error)

+ func NewUploadSummary() (*CommandSummary, error)

+ func (cs *CommandSummary) GenerateMarkdown() error

+ func (cs *CommandSummary) GetDataFilesPaths() ([]string, error)

+ func (cs *CommandSummary) GetIndexedDataFilesPaths() (indexedFilePathsMap IndexedFilesMap, err error)

+ func (cs *CommandSummary) Record(data any) (err error)

+ func (cs *CommandSummary) RecordWithIndex(data any, summaryIndex Index, args ...string) (err error)

+ type CommandSummaryInterface interface

+ GenerateMarkdownFromFiles func(dataFilePaths []string) (finalMarkdown string, err error)

+ type Index string

+ const BinariesScan

+ const BuildScan

+ const DockerScan

+ const SarifReport

+ type IndexedFilesMap map[Index]map[string]string

+ type MarkdownConfig struct

+ func (mg *MarkdownConfig) GetExtendedSummaryLangPage() string

+ func (mg *MarkdownConfig) GetPlatformMajorVersion() int

+ func (mg *MarkdownConfig) GetPlatformUrl() string

+ func (mg *MarkdownConfig) IsExtendedSummary() bool

+ func (mg *MarkdownConfig) SetScanResultsMapping(resultsMap map[string]ScanResult)

+ type ResultsWrapper struct

+ Results []UploadResult

+ type ScanResult interface

+ GetViolations func() string

+ GetVulnerabilities func() string

+ type ScanResultMarkdownInterface interface

+ BinaryScan func(filePaths []string) (result ScanResult)

+ BuildScan func(filePaths []string) (result ScanResult)

+ DockerScan func(filePaths []string) (result ScanResult)

+ GetNonScanned func() (nonScanned ScanResult)

+ type UploadResult struct

+ RtUrl string

+ SourcePath string

+ TargetPath string

+ type UploadSummary struct

+ func (us *UploadSummary) GenerateMarkdownFromFiles(dataFilePaths []string) (markdown string, err error)

+ func (us *UploadSummary) GetSummaryTitle() string