diff --git a/.github/workflows/frogbot-scan-and-fix.yml b/.github/workflows/frogbot-scan-and-fix.yml index 8a587192a..5fc6974d9 100644 --- a/.github/workflows/frogbot-scan-and-fix.yml +++ b/.github/workflows/frogbot-scan-and-fix.yml @@ -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. ## diff --git a/docs/install-azure-repos.md b/docs/install-azure-repos.md index c0c132631..b5b84cf9b 100644 --- a/docs/install-azure-repos.md +++ b/docs/install-azure-repos.md @@ -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: "" ########################################################################## diff --git a/docs/install-bitbucket-server.md b/docs/install-bitbucket-server.md index 9ea7a0001..3f3937fbd 100644 --- a/docs/install-bitbucket-server.md +++ b/docs/install-bitbucket-server.md @@ -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= "" /////////////////////////////////////////////////////////////////////////// diff --git a/docs/install-github.md b/docs/install-github.md index 80c547de6..3dc8e9149 100644 --- a/docs/install-github.md +++ b/docs/install-github.md @@ -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= "" /////////////////////////////////////////////////////////////////////////// diff --git a/docs/install-gitlab.md b/docs/install-gitlab.md index a8f143328..e7a6e43a0 100644 --- a/docs/install-gitlab.md +++ b/docs/install-gitlab.md @@ -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: "" ########################################################################### diff --git a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-go.yml b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-go.yml index a5c051089..8f9504c8e 100644 --- a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-go.yml +++ b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-go.yml @@ -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: "" ########################################################################## diff --git a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-maven.yml b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-maven.yml index 242463210..ce296b238 100644 --- a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-maven.yml +++ b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-maven.yml @@ -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: "" ########################################################################## @@ -118,4 +128,4 @@ jobs: # [Optional, Default: eco-system+frogbot@jfrog.com] # Set the email of the commit author - # JF_GIT_EMAIL_AUTHOR: "" \ No newline at end of file + # JF_GIT_EMAIL_AUTHOR: "" diff --git a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-npm.yml b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-npm.yml index 99581f0a4..640e179c9 100644 --- a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-npm.yml +++ b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-npm.yml @@ -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: "" ########################################################################## @@ -124,4 +134,4 @@ jobs: # [Optional, Default: eco-system+frogbot@jfrog.com] # Set the email of the commit author - # JF_GIT_EMAIL_AUTHOR: "" \ No newline at end of file + # JF_GIT_EMAIL_AUTHOR: "" diff --git a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pip.yml b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pip.yml index 030e53c8a..ddbe1368f 100644 --- a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pip.yml +++ b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pip.yml @@ -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: "" ########################################################################## @@ -121,4 +131,4 @@ jobs: # [Optional, Default: eco-system+frogbot@jfrog.com] # Set the email of the commit author - # JF_GIT_EMAIL_AUTHOR: "" \ No newline at end of file + # JF_GIT_EMAIL_AUTHOR: "" diff --git a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pipenv.yml b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pipenv.yml index f1c79ad23..2bf857572 100644 --- a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pipenv.yml +++ b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-pipenv.yml @@ -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: "" ########################################################################## @@ -124,4 +134,4 @@ jobs: # [Optional, Default: eco-system+frogbot@jfrog.com] # Set the email of the commit author - # JF_GIT_EMAIL_AUTHOR: "" \ No newline at end of file + # JF_GIT_EMAIL_AUTHOR: "" diff --git a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-poetry.yml b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-poetry.yml index d73e4647e..835977fa0 100644 --- a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-poetry.yml +++ b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-poetry.yml @@ -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: "" ########################################################################## @@ -121,4 +131,4 @@ jobs: # [Optional, Default: eco-system+frogbot@jfrog.com] # Set the email of the commit author - # JF_GIT_EMAIL_AUTHOR: "" \ No newline at end of file + # JF_GIT_EMAIL_AUTHOR: "" diff --git a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-yarn.yml b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-yarn.yml index 99581f0a4..640e179c9 100644 --- a/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-yarn.yml +++ b/docs/templates/github-actions/scan-and-fix/frogbot-scan-and-fix-yarn.yml @@ -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: "" ########################################################################## @@ -124,4 +134,4 @@ jobs: # [Optional, Default: eco-system+frogbot@jfrog.com] # Set the email of the commit author - # JF_GIT_EMAIL_AUTHOR: "" \ No newline at end of file + # JF_GIT_EMAIL_AUTHOR: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-dotnet.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-dotnet.yml index fc918b6ad..d568a0d6b 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-dotnet.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-dotnet.yml @@ -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. ## @@ -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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-go.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-go.yml index f2d0026d7..ab92eb46d 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-go.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-go.yml @@ -45,13 +45,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. ## @@ -95,4 +103,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-gradle.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-gradle.yml index cce803dbe..d5050f1fa 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-gradle.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-gradle.yml @@ -49,13 +49,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. ## @@ -99,4 +107,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-maven.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-maven.yml index 3645744f2..d5894357d 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-maven.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-maven.yml @@ -46,13 +46,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. ## @@ -96,4 +104,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-npm.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-npm.yml index 78c45c728..045958c49 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-npm.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-npm.yml @@ -45,13 +45,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. ## @@ -102,4 +110,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-nuget.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-nuget.yml index a241d9a00..6209124aa 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-nuget.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-nuget.yml @@ -44,13 +44,21 @@ jobs: JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }} # [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. ## @@ -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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pip.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pip.yml index 75431ffe1..7828395fe 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pip.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pip.yml @@ -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. ## @@ -98,4 +106,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pipenv.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pipenv.yml index a2a121b1f..225a67d62 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pipenv.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-pipenv.yml @@ -46,13 +46,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. ## @@ -100,4 +108,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-poetry.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-poetry.yml index de92620ca..c7fed59e7 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-poetry.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-poetry.yml @@ -46,13 +46,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. ## @@ -96,4 +104,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-yarn.yml b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-yarn.yml index bffc458f3..15a164145 100644 --- a/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-yarn.yml +++ b/docs/templates/github-actions/scan-pull-request/frogbot-scan-pr-yarn.yml @@ -45,13 +45,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. ## @@ -102,4 +110,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: "" \ No newline at end of file + # JF_MIN_SEVERITY: "" diff --git a/docs/templates/jfrog-pipelines/pipelines-dotnet.yml b/docs/templates/jfrog-pipelines/pipelines-dotnet.yml index d4a4e36f4..18acb90d9 100644 --- a/docs/templates/jfrog-pipelines/pipelines-dotnet.yml +++ b/docs/templates/jfrog-pipelines/pipelines-dotnet.yml @@ -62,9 +62,19 @@ pipelines: 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: "" ########################################################################### diff --git a/docs/templates/jfrog-pipelines/pipelines-go.yml b/docs/templates/jfrog-pipelines/pipelines-go.yml index 1710c4ede..65f95d12d 100644 --- a/docs/templates/jfrog-pipelines/pipelines-go.yml +++ b/docs/templates/jfrog-pipelines/pipelines-go.yml @@ -62,9 +62,19 @@ pipelines: 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: "" ########################################################################### @@ -176,4 +186,4 @@ pipelines: # restore_cache_files dotnet_cache "%userprofile%\go\packages" # .\frogbot.exe scan-pull-requests # .\frogbot.exe scan-and-fix-repos - # add_cache_files dotnet_cache "%userprofile%\go\packages" || true \ No newline at end of file + # add_cache_files dotnet_cache "%userprofile%\go\packages" || true diff --git a/docs/templates/jfrog-pipelines/pipelines-gradle.yml b/docs/templates/jfrog-pipelines/pipelines-gradle.yml index ffad77a67..efdc5831a 100644 --- a/docs/templates/jfrog-pipelines/pipelines-gradle.yml +++ b/docs/templates/jfrog-pipelines/pipelines-gradle.yml @@ -62,9 +62,19 @@ pipelines: 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: "" ########################################################################### diff --git a/docs/templates/jfrog-pipelines/pipelines-maven.yml b/docs/templates/jfrog-pipelines/pipelines-maven.yml index 83f1a1070..f0882d7e5 100644 --- a/docs/templates/jfrog-pipelines/pipelines-maven.yml +++ b/docs/templates/jfrog-pipelines/pipelines-maven.yml @@ -62,9 +62,19 @@ pipelines: 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: "" ########################################################################### @@ -168,4 +178,4 @@ pipelines: # Invoke-Expression (Invoke-WebRequest -Uri $scriptUrl -UseBasicParsing).Content # add_cache_files "%userprofile%\.m2" maven_cache || true # .\frogbot.exe scan-pull-requests - # .\frogbot.exe scan-and-fix-repos \ No newline at end of file + # .\frogbot.exe scan-and-fix-repos diff --git a/docs/templates/jfrog-pipelines/pipelines-npm.yml b/docs/templates/jfrog-pipelines/pipelines-npm.yml index 71339d900..f956aac85 100644 --- a/docs/templates/jfrog-pipelines/pipelines-npm.yml +++ b/docs/templates/jfrog-pipelines/pipelines-npm.yml @@ -62,9 +62,19 @@ pipelines: 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: "" ########################################################################### diff --git a/docs/templates/jfrog-pipelines/pipelines-pip.yml b/docs/templates/jfrog-pipelines/pipelines-pip.yml index ee75314e8..bee1b1d6c 100644 --- a/docs/templates/jfrog-pipelines/pipelines-pip.yml +++ b/docs/templates/jfrog-pipelines/pipelines-pip.yml @@ -69,9 +69,19 @@ pipelines: 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: "" ########################################################################### diff --git a/docs/templates/jfrog-pipelines/pipelines-pipenv.yml b/docs/templates/jfrog-pipelines/pipelines-pipenv.yml index f0594945a..0ad0b311d 100644 --- a/docs/templates/jfrog-pipelines/pipelines-pipenv.yml +++ b/docs/templates/jfrog-pipelines/pipelines-pipenv.yml @@ -62,9 +62,19 @@ pipelines: 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: "" ########################################################################### @@ -172,4 +182,4 @@ pipelines: # $scriptUrl = "$($getFrogbotScriptPath)/artifactory/frogbot/v2/[RELEASE]/getFrogbot.sh" # Invoke-Expression (Invoke-WebRequest -Uri $scriptUrl -UseBasicParsing).Content # .\frogbot.exe scan-pull-requests - # .\frogbot.exe scan-and-fix-repos \ No newline at end of file + # .\frogbot.exe scan-and-fix-repos diff --git a/docs/templates/jfrog-pipelines/pipelines-poetry.yml b/docs/templates/jfrog-pipelines/pipelines-poetry.yml index 8e5ba6903..e3ad3efe5 100644 --- a/docs/templates/jfrog-pipelines/pipelines-poetry.yml +++ b/docs/templates/jfrog-pipelines/pipelines-poetry.yml @@ -62,9 +62,19 @@ pipelines: 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: "" ########################################################################### diff --git a/docs/templates/jfrog-pipelines/pipelines-yarn2.yml b/docs/templates/jfrog-pipelines/pipelines-yarn2.yml index 3d6bdffb0..e92c5b9e9 100644 --- a/docs/templates/jfrog-pipelines/pipelines-yarn2.yml +++ b/docs/templates/jfrog-pipelines/pipelines-yarn2.yml @@ -69,9 +69,19 @@ pipelines: 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: "" ########################################################################### diff --git a/starter-workflows/code-scanning/frogbot-scan-and-fix.yml b/starter-workflows/code-scanning/frogbot-scan-and-fix.yml index 8618859a0..43b65b699 100644 --- a/starter-workflows/code-scanning/frogbot-scan-and-fix.yml +++ b/starter-workflows/code-scanning/frogbot-scan-and-fix.yml @@ -57,9 +57,19 @@ jobs: JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }} # [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: "" ########################################################################## diff --git a/starter-workflows/code-scanning/frogbot-scan-pr.yml b/starter-workflows/code-scanning/frogbot-scan-pr.yml index 2c5488f50..c72c7ded3 100644 --- a/starter-workflows/code-scanning/frogbot-scan-pr.yml +++ b/starter-workflows/code-scanning/frogbot-scan-pr.yml @@ -51,13 +51,21 @@ jobs: JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }} # [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 you project uses a 'frogbot-config.yml' file, you can define ## ## the following variables inside the file, instead of here. ##