Skip to content

Commit 2308cad

Browse files
authored
Update job summary documentation (#178)
1 parent 5823508 commit 2308cad

File tree

3 files changed

+17
-9
lines changed

3 files changed

+17
-9
lines changed

README.md

+17-9
Original file line numberDiff line numberDiff line change
@@ -286,24 +286,24 @@ Here's how you do this:
286286

287287
## JFrog Job Summary
288288

289-
The **setup-jfrog-cli GitHub Action** leverages the **Command Summaries** feature of the JFrog CLI
290-
to generate a detailed summary of the entire workflow.
289+
Jobs using this GitHub action will output a summary of some of the key commands that were performed using JFrog CLI.
291290

292291
The summary can be viewed from the GitHub Actions run page and is enabled by default.
293292

294-
The summary will include the summary of CLI commands which support this feature.
295-
To read more about the JFrog CLI supported commands, visit the following link:
296-
[JFrog CLI Command Summaries Documentation](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-command-summaries)
293+
### Preconditions
294+
To fully leverage from the JFrog Job Summary, one should:
295+
1. Use JFrog CLI version 2.62.0 or above.
296+
2. Set `JF_URL` as a variable rather than a secret (see note below).
297+
3. [Collect build info](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration) and [publish](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/build-integration#publishing-build-info) it using JFrog CLI.
297298

298-
299-
Notice that the Job Summary UI includes direct links to the JFrog Platform UI.
300-
It's important to note that for the platform links to function correctly,
299+
> **_NOTE:_** The Job Summary includes direct links to the JFrog Platform UI.
300+
For the links to function correctly,
301301
`JF_URL` should be set as a variable rather than a secret.
302302
This is to prevent GitHub from masking the URL.
303303

304304
Example JFrog Job Summary:
305305

306-
![JFrog-Job-Summary](images/JFrog-Job-Summary.png)
306+
![JFrog-Job-Summary](images/job_summary.png)
307307

308308

309309
Job summaries can be disabled by setting the `disable-job-summary` input to `true`.
@@ -314,6 +314,14 @@ Job summaries can be disabled by setting the `disable-job-summary` input to `tru
314314
disable-job-summary: true
315315
```
316316

317+
### Behind the scenes
318+
The **setup-jfrog-cli GitHub Action** leverages the **Command Summaries** feature of the JFrog CLI
319+
to generate a detailed summary of the entire workflow.
320+
321+
The final summary will include the summary of each CLI command that supports this feature.
322+
To read more about the JFrog CLI supported commands, visit the following link:
323+
[JFrog CLI Command Summaries Documentation](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-command-summaries).
324+
317325
## Example projects
318326

319327
To help you get started, you can use [these](https://github.com/jfrog/project-examples/tree/master/github-action-examples) sample projects on GitHub.

images/JFrog-Job-Summary.png

-88 KB
Binary file not shown.

images/job_summary.png

232 KB
Loading

0 commit comments

Comments
 (0)