Change starter-workflows naming (#122)

* Frogbot templates naming refactor
jfrog · Aug 16, 2022 · a4f0d23 · a4f0d23
1 parent c8dfced
commit a4f0d23
Show file tree

Hide file tree

Showing 19 changed files with 35 additions and 24 deletions.
diff --git a/.github/workflows/frogbot-fix.yml → .github/workflows/frogbot-scan-and-fix.yml b/.github/workflows/frogbot-fix.yml → .github/workflows/frogbot-scan-and-fix.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Fix"
+name: "Frogbot Scan and Fix"
 on:
   push:
     branches:

diff --git a/.github/workflows/frogbot-pull-request.yml → .github/workflows/frogbot-scan-pr.yml b/.github/workflows/frogbot-pull-request.yml → .github/workflows/frogbot-scan-pr.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [ opened, synchronize ]

diff --git a/starter-workflows/README.md b/starter-workflows/README.md
@@ -3,8 +3,8 @@
 This directory includes the code for Frogbot's Code Scanning GitHub templates.
 Currently two templates are supported:
 
-1. Frogbot Scan - which allows editing and then adding the frogbot-scan-pr.yml workflow.
-2. Frogbot Fix - which allows editing and then adding the forgbot-fix.yml workflow.
+1. Frogbot Scan Pull Request - which allows editing and then adding the frogbot-scan-pr.yml workflow.
+2. Frogbot Scan and Fix - which allows editing and then adding the forgbot-fix.yml workflow.
 
 To start using Starter-Workflows, please refer to
 the [Using starter workflows GitHub documentation.](https://docs.github.com/en/actions/using-workflows/using-starter-workflows)

diff --git a/...r-workflows/code-scanning/frogbot-fix.yml → ...ws/code-scanning/frogbot-scan-and-fix.yml b/...r-workflows/code-scanning/frogbot-fix.yml → ...ws/code-scanning/frogbot-scan-and-fix.yml
@@ -7,7 +7,7 @@
 # Uses JFrog Xray to scan the project.
 # Read more about Frogbot here - https://github.com/jfrog/frogbot#frogbot
 
-name: "Frogbot Fix"
+name: "Frogbot Scan and Fix"
 on:
   push:
     branches:

diff --git a/starter-workflows/code-scanning/frogbot-scan-pr.yml b/starter-workflows/code-scanning/frogbot-scan-pr.yml
@@ -7,7 +7,7 @@
 # Uses JFrog Xray to scan the project.
 # Read more about Frogbot here - https://github.com/jfrog/frogbot#frogbot
 
-name: "Frogbot Scan"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [ opened, synchronize ]

diff --git a/...ng/properties/frogbot-fix.properties.json → ...ties/frogbot-scan-and-fix.properties.json b/...ng/properties/frogbot-fix.properties.json → ...ties/frogbot-scan-and-fix.properties.json
diff --git a/starter-workflows/code-scanning/properties/frogbot-scan-pr.properties.json b/starter-workflows/code-scanning/properties/frogbot-scan-pr.properties.json
@@ -1,5 +1,5 @@
 {
-  "name": "Frogbot Scan Pull Requests",
+  "name": "Frogbot Scan Pull Request",
   "description": "Automatically scans new pull requests for security vulnerabilities. Uses JFrog Xray to scan the project. Included as part of JFrog's free subscription.",
   "iconName": "frogbot",
   "categories": [

diff --git a/templates/github-actions/README.md b/templates/github-actions/README.md
@@ -3,7 +3,8 @@
 Use these templates to install [Frogbot](https://github.com/jfrog/frogbot/blob/master/README.md#frogbot) on your GitHub repository.
 
 ## Prerequisites
-Make sure to [set up 'frogbot' environment and secrets](../../README.md#install-frogbot-using-github-actions) in your GitHub repository.
+Make sure to [set up 'frogbot' environment and secrets](../../README.md#setting-up-frogbot-on-github-repositories) in
+your GitHub repository.
 
 ## Using the Templates
 1. Use the templates below, depending on the tool used to download dependencies for you project, to create the workflow files.
@@ -12,7 +13,12 @@ Make sure to [set up 'frogbot' environment and secrets](../../README.md#install-
 
 ## The Available Templates
 ### Pull Requests Scanning
-Create a file named `frogbot-scan-pull-requests.yml` with the content of one of the following templates, depending on the tool used to download the project dependencies. Make sure to follow the guidelines in the 'Using the Templates' section above. This will allow Frogbot to scan pull requests for security vulnerabilities after the pull requests are created and before they are merged.
+
+Create a file named `frogbot-scan-pull-request.yml` with the content of one of the following templates, depending on the
+tool used to download the project dependencies. Make sure to follow the guidelines in the 'Using the Templates' section
+above. This will allow Frogbot to scan pull requests for security vulnerabilities after the pull requests are created
+and before they are merged.
+
 - [Maven](scan-pull-request/frogbot-scan-pr-maven.yml)
 - [Gradle](scan-pull-request/frogbot-scan-pr-gradle.yml)
 - [npm](scan-pull-request/frogbot-scan-pr-npm.yml)
@@ -21,8 +27,13 @@ Create a file named `frogbot-scan-pull-requests.yml` with the content of one of
 - [Go](scan-pull-request/frogbot-scan-pr-go.yml)
 - [DotNet](scan-pull-request/frogbot-scan-pr-dotnet.yml)
 - [NuGet](scan-pull-request/frogbot-scan-pr-nuget.yml)
+
 ### Pull Requests Opening
-Create a file named `frogbot-open-pull-requests.yml` with the content of one of the following templates, depending on the tool used to download the project dependencies. Make sure to follow the guidelines in the 'Using the Templates' section above. This will make Frogbot open pull requests with fixes for security vulnerabilities found in the GitHub repository.
-- [Maven](create-fix-pull-requests/frogbot-fix-maven.yml)
-- [npm](create-fix-pull-requests/frogbot-fix-npm.yml)
-- [Go](create-fix-pull-requests/frogbot-fix-go.yml)
+
+Create a file named `frogbot-scan-and-fix.yml` with the content of one of the following templates, depending on the tool
+used to download the project dependencies. Make sure to follow the guidelines in the 'Using the Templates' section
+above. This will make Frogbot open pull requests with fixes for security vulnerabilities found in the GitHub repository.
+
+- [Maven](scan-and-fix/frogbot-scan-and-fix-maven.yml)
+- [npm](scan-and-fix/frogbot-scan-and-fix-npm.yml)
+- [Go](scan-and-fix/frogbot-scan-and-fix-go.yml)
diff --git a/...eate-fix-pull-requests/frogbot-fix-go.yml → .../scan-and-fix/frogbot-scan-and-fix-go.yml b/...eate-fix-pull-requests/frogbot-fix-go.yml → .../scan-and-fix/frogbot-scan-and-fix-go.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Fix"
+name: "Frogbot Scan and Fix"
 on:
   push:
     # Creating fix pull requests will be triggered by any push to one of the these branches.

diff --git a/...e-fix-pull-requests/frogbot-fix-maven.yml → ...an-and-fix/frogbot-scan-and-fix-maven.yml b/...e-fix-pull-requests/frogbot-fix-maven.yml → ...an-and-fix/frogbot-scan-and-fix-maven.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Fix"
+name: "Frogbot Scan and Fix"
 on:
   push:
     # Creating fix pull requests will be triggered by any push to one of the these branches.

diff --git a/...ate-fix-pull-requests/frogbot-fix-npm.yml → ...scan-and-fix/frogbot-scan-and-fix-npm.yml b/...ate-fix-pull-requests/frogbot-fix-npm.yml → ...scan-and-fix/frogbot-scan-and-fix-npm.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Fix"
+name: "Frogbot Scan and Fix"
 on:
   push:
     # Creating fix pull requests will be triggered by any push to one of the these branches.

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-dotnet.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-dotnet.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-go.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-go.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-gradle.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-gradle.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-maven.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-maven.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-npm.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-npm.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-nuget.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-nuget.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-pip.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-pip.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]

diff --git a/templates/github-actions/scan-pull-request/frogbot-scan-pr-pipenv.yml b/templates/github-actions/scan-pull-request/frogbot-scan-pr-pipenv.yml
@@ -1,4 +1,4 @@
-name: "Frogbot Scan PR"
+name: "Frogbot Scan Pull Request"
 on:
   pull_request_target:
     types: [opened, synchronize]