From 47b70f0e2aa37f28bca20d2d3535866b60c089af Mon Sep 17 00:00:00 2001 From: Robi Nino Date: Thu, 19 Sep 2024 14:35:11 +0300 Subject: [PATCH] Add supported commands documentation (#216) --- README.md | 21 ++++++++++++++++++++- images/icons/docker.svg | 1 + images/icons/generic.svg | 35 +++++++++++++++++++++++++++++++++++ images/icons/go.svg | 1 + images/icons/maven.svg | 1 + images/icons/npm.svg | 1 + images/icons/pypi.svg | 1 + images/icons/terraform.svg | 1 + 8 files changed, 61 insertions(+), 1 deletion(-) create mode 100644 images/icons/docker.svg create mode 100644 images/icons/generic.svg create mode 100644 images/icons/go.svg create mode 100644 images/icons/maven.svg create mode 100644 images/icons/npm.svg create mode 100644 images/icons/pypi.svg create mode 100644 images/icons/terraform.svg diff --git a/README.md b/README.md index b78b15571..252cad465 100644 --- a/README.md +++ b/README.md @@ -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 | `jf mvn install` | +| | `jf npm install` | +| | `jf pip/pipenv/poetry install` | +| | `jf go build` | +| Build Info | `jf rt build-publish` ([automatically](#default-behavior) or manually) | +| Build Info: Security | `jf build-scan` | +| Published Modules: Artifacts | `jf docker push`, `jf rt build-docker-create` | +| | `jf mvn install` | +| | `jf npm publish` | +| | `jf twine upload` | +| | `jf go publish` | +| | `jf terraform publish` | +| | `jf rt upload` | +| Published Modules: Security | `jf docker scan` | +| Code Scanning | `jf docker scan`, `jf scan` | + +### JFrog Job Summary Example ![JFrog-Job-Summary](images/job_summary.png) diff --git a/images/icons/docker.svg b/images/icons/docker.svg new file mode 100644 index 000000000..bbeaed2ef --- /dev/null +++ b/images/icons/docker.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/icons/generic.svg b/images/icons/generic.svg new file mode 100644 index 000000000..5fc2084c4 --- /dev/null +++ b/images/icons/generic.svg @@ -0,0 +1,35 @@ + + + + + + + + + + + + + + + + Generic + + + + + + + + + + + + + + + + + + + diff --git a/images/icons/go.svg b/images/icons/go.svg new file mode 100644 index 000000000..0fbf6fd1d --- /dev/null +++ b/images/icons/go.svg @@ -0,0 +1 @@ + diff --git a/images/icons/maven.svg b/images/icons/maven.svg new file mode 100644 index 000000000..0b0e0a15d --- /dev/null +++ b/images/icons/maven.svg @@ -0,0 +1 @@ +file_type_maven \ No newline at end of file diff --git a/images/icons/npm.svg b/images/icons/npm.svg new file mode 100644 index 000000000..2ee0f35b5 --- /dev/null +++ b/images/icons/npm.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/icons/pypi.svg b/images/icons/pypi.svg new file mode 100644 index 000000000..43d9833b3 --- /dev/null +++ b/images/icons/pypi.svg @@ -0,0 +1 @@ + diff --git a/images/icons/terraform.svg b/images/icons/terraform.svg new file mode 100644 index 000000000..6a17e8680 --- /dev/null +++ b/images/icons/terraform.svg @@ -0,0 +1 @@ +