Add GitHub Actions summary for the create evidence command #1423
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Jul 27, 2025
selalererjfrog
approved these changes
Jul 27, 2025
mnsboev
force-pushed
the
create-evidence-summary
branch
from
a54b8a4 to
2db73d4
Compare
ehl-jf
approved these changes
Aug 4, 2025
dortam888
reviewed
Aug 4, 2025
|
|
||
| func GenerateEvidenceUrlByType(data EvidenceSummaryData, section summarySection) (string, error) { | ||
| switch data.SubjectType { | ||
| // Currently, it is not possible to generate a link to the evidence tab for packages in the Artifactory UI. |
Collaborator
There was a problem hiding this comment.
I'm not ok with merging this comment on an open source.
| } | ||
|
|
||
| func generateReleaseBundleEvidenceUrl(data EvidenceSummaryData, section summarySection) (string, error) { | ||
| if data.ReleaseBundleName == "" || data.ReleaseBundleVersion == "" { |
Collaborator
There was a problem hiding this comment.
explain this use case? when do we find release bundle type without release bundle name and release bundle version
| urlStr := fmt.Sprintf(releaseBundleEvidenceFormat, | ||
| StaticMarkdownConfig.GetPlatformUrl(), | ||
| data.ReleaseBundleName, | ||
| data.RepoKey, |
Collaborator
There was a problem hiding this comment.
What is the repokey in this case?
-release-bundle-v2?
| ReleaseBundleName string `json:"releaseBundleName"` | ||
| ReleaseBundleVersion string `json:"releaseBundleVersion"` | ||
| RepoKey string `json:"repoKey"` | ||
| CreatedAt time.Time `json:"createdAt"` |
|
|
||
| const evidenceHeaderSize = 3 | ||
|
|
||
| type EvidenceSummaryData struct { |
Collaborator
There was a problem hiding this comment.
Do we have to have it here?
It creates decoupling each time we will want to add a field we will have to go here as well.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add Summary Markdown Table for Create Evidence Command
This PR is part of a series of three that enhances the documentation for the "create evidence" command by introducing a summary markdown table.
jfrog-cli PR: jfrog/jfrog-cli#3042
jfrog-cli-artifactory PR: jfrog/jfrog-cli-artifactory#112
Summary
This addition aims to improve the user experience by providing a clear and concise overview of the evidence being created. The markdown table includes the following columns:
Evidence Subject: Links to the relevant evidence files, allowing users to easily access them.
Evidence Type: Specifies the type of evidence being recorded (e.g., in-toto).
Verification Status: Indicates whether the evidence has been verified, complete with visual status indicators (e.g., ✅ Verified).
Example Output
When the create evidence command is executed, users will see a collapsible section that looks like this:
🔎 Evidence