Skip to content

Commit

Permalink
Add supported commands documentation (#216)
Browse files Browse the repository at this point in the history
  • Loading branch information
RobiNino authored Sep 19, 2024
1 parent f93091f commit 47b70f0
Show file tree
Hide file tree
Showing 8 changed files with 61 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,26 @@ To disable the JFrog Job Summary altogether, set the `disable-job-summary` input
disable-job-summary: true
```

### JFrog Job Summary Example:
### Published Sections
| Section | Command |
|-------------------------------|----------------------------------------------------------------------------------------------|
| Curation Audit | <img src="images/icons/maven.svg" width="30"> `jf mvn install` |
| | <img src="images/icons/npm.svg" width="30"> `jf npm install` |
| | <img src="images/icons/pypi.svg" width="30"> `jf pip/pipenv/poetry install` |
| | <img src="images/icons/go.svg" width="30"> `jf go build` |
| Build Info | `jf rt build-publish` ([automatically](#default-behavior) or manually) |
| Build Info: Security | `jf build-scan` |
| Published Modules: Artifacts | <img src="images/icons/docker.svg" width="30"> `jf docker push`, `jf rt build-docker-create` |
| | <img src="images/icons/maven.svg" width="30"> `jf mvn install` |
| | <img src="images/icons/npm.svg" width="30"> `jf npm publish` |
| | <img src="images/icons/pypi.svg" width="30"> `jf twine upload` |
| | <img src="images/icons/go.svg" width="30"> `jf go publish` |
| | <img src="images/icons/terraform.svg" width="30"> `jf terraform publish` |
| | <img src="images/icons/generic.svg" width="30"> `jf rt upload` |
| Published Modules: Security | <img src="images/icons/docker.svg" width="30"> `jf docker scan` |
| Code Scanning | `jf docker scan`, `jf scan` |

### JFrog Job Summary Example

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

Expand Down
1 change: 1 addition & 0 deletions images/icons/docker.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions images/icons/generic.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions images/icons/go.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 47b70f0

Please sign in to comment.