Skip to content

Commit

Permalink
Workflows docs updates (#409)
Browse files Browse the repository at this point in the history
  • Loading branch information
@eyalbe4
eyalbe4 authored Aug 3, 2023
1 parent c4cc942 commit c7683d5
Show file tree
Hide file tree
Showing 33 changed files with 448 additions and 142 deletions.
18 changes: 13 additions & 5 deletions .github/workflows/frogbot-scan-and-fix.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,21 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""



##########################################################################
## If your project uses a 'frogbot-config.yml' file, you can define ##
## the following variables inside the file, instead of here. ##
Expand Down
16 changes: 13 additions & 3 deletions docs/install-azure-repos.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,19 @@ To install Frogbot on Azure Repos repositories, follow these steps.
JF_GIT_OWNER: ""

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down
16 changes: 13 additions & 3 deletions docs/install-bitbucket-server.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,19 @@
JF_GIT_API_ENDPOINT= ""
// [Optional]
// If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
// in Artifactory, which proxies https://releases.jfrog.io
// The 'frogbot' executable and other tools it needs will be downloaded through this repository.
// By default, the Frogbot workflows download the Frogbot executable as well as other tools
// needed from https://releases.jfrog.io
// If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
// executable to be downloaded from an Artifactory instance, which the machine has access to:
//
// 1. Login to the Artifactory UI, with a user which has admin credentials.
// 2. Create a Remote Repository with the following properties set.
// Under the 'Basic' tab:
// Package Type: Generic
// URL: https://releases.jfrog.io
// Under the 'Advanced' tab:
// Uncheck the 'Store Artifacts Locally' option
// 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
// JF_RELEASES_REPO= ""
///////////////////////////////////////////////////////////////////////////
Expand Down
16 changes: 13 additions & 3 deletions docs/install-github.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,9 +108,19 @@
JF_GIT_API_ENDPOINT = ""
// [Optional]
// If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
// in Artifactory, which proxies https://releases.jfrog.io
// The 'frogbot' executable and other tools it needs will be downloaded through this repository.
// By default, the Frogbot workflows download the Frogbot executable as well as other tools
// needed from https://releases.jfrog.io
// If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
// executable to be downloaded from an Artifactory instance, which the machine has access to:
//
// 1. Login to the Artifactory UI, with a user which has admin credentials.
// 2. Create a Remote Repository with the following properties set.
// Under the 'Basic' tab:
// Package Type: Generic
// URL: https://releases.jfrog.io
// Under the 'Advanced' tab:
// Uncheck the 'Store Artifacts Locally' option
// 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
// JF_RELEASES_REPO= ""
///////////////////////////////////////////////////////////////////////////
Expand Down
16 changes: 13 additions & 3 deletions docs/install-gitlab.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,19 @@ frogbot-scan:
# JF_GIT_API_ENDPOINT: https://gitlab.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

###########################################################################
Expand Down
16 changes: 13 additions & 3 deletions docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-go.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,19 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down
18 changes: 14 additions & 4 deletions docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-maven.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,19 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down Expand Up @@ -118,4 +128,4 @@ jobs:

# [Optional, Default: eco-system+frogbot@jfrog.com]
# Set the email of the commit author
# JF_GIT_EMAIL_AUTHOR: ""
# JF_GIT_EMAIL_AUTHOR: ""
18 changes: 14 additions & 4 deletions docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-npm.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,19 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down Expand Up @@ -124,4 +134,4 @@ jobs:

# [Optional, Default: eco-system+frogbot@jfrog.com]
# Set the email of the commit author
# JF_GIT_EMAIL_AUTHOR: ""
# JF_GIT_EMAIL_AUTHOR: ""
18 changes: 14 additions & 4 deletions docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pip.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,19 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down Expand Up @@ -121,4 +131,4 @@ jobs:

# [Optional, Default: eco-system+frogbot@jfrog.com]
# Set the email of the commit author
# JF_GIT_EMAIL_AUTHOR: ""
# JF_GIT_EMAIL_AUTHOR: ""
18 changes: 14 additions & 4 deletions docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pipenv.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,19 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down Expand Up @@ -124,4 +134,4 @@ jobs:

# [Optional, Default: eco-system+frogbot@jfrog.com]
# Set the email of the commit author
# JF_GIT_EMAIL_AUTHOR: ""
# JF_GIT_EMAIL_AUTHOR: ""
18 changes: 14 additions & 4 deletions docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-poetry.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,19 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down Expand Up @@ -121,4 +131,4 @@ jobs:

# [Optional, Default: eco-system+frogbot@jfrog.com]
# Set the email of the commit author
# JF_GIT_EMAIL_AUTHOR: ""
# JF_GIT_EMAIL_AUTHOR: ""
18 changes: 14 additions & 4 deletions docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-yarn.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,19 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""

##########################################################################
Expand Down Expand Up @@ -124,4 +134,4 @@ jobs:

# [Optional, Default: eco-system+frogbot@jfrog.com]
# Set the email of the commit author
# JF_GIT_EMAIL_AUTHOR: ""
# JF_GIT_EMAIL_AUTHOR: ""
20 changes: 14 additions & 6 deletions docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-dotnet.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,21 @@ jobs:
# JF_GIT_API_ENDPOINT: https://github.example.com

# [Optional]
# If the machine that runs Frogbot has no access to the internet, set the name of a remote repository
# in Artifactory, which proxies https://releases.jfrog.io
# The 'frogbot' executable and other tools it needs will be downloaded through this repository.
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
# needed from https://releases.jfrog.io
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
# executable to be downloaded from an Artifactory instance, which the machine has access to:
#
# 1. Login to the Artifactory UI, with a user which has admin credentials.
# 2. Create a Remote Repository with the following properties set.
# Under the 'Basic' tab:
# Package Type: Generic
# URL: https://releases.jfrog.io
# Under the 'Advanced' tab:
# Uncheck the 'Store Artifacts Locally' option
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
# JF_RELEASES_REPO: ""



##########################################################################
## If your project uses a 'frogbot-config.yml' file, you can define ##
## the following variables inside the file, instead of here. ##
Expand Down Expand Up @@ -101,4 +109,4 @@ jobs:
# [Optional]
# Set the minimum severity for vulnerabilities that should be fixed and commented on in pull requests
# The following values are accepted: Low, Medium, High or Critical
# JF_MIN_SEVERITY: ""
# JF_MIN_SEVERITY: ""
Loading

0 comments on commit c7683d5

Please sign in to comment.