CR Changes

jfrog · omerzi · Aug 17, 2023 · Aug 9, 2023 · Aug 9, 2023 · Aug 9, 2023
commit a0e2d2a3ccf7c4287f48d18ea5ee1c9d527d99bf
diff --git a/docs/install-azure-pipelines.md b/docs/install-azure-pipelines.md
@@ -240,19 +240,25 @@ jobs:
             #       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: ""
+
+            # [Optional]
+            # Configure the SMTP server to enable Frogbot to send emails with detected secrets in pull request scans.
+            # SMTP server URL including should the relevant port: (Example: smtp.server.com:8080)
+            # JF_SMTP_SERVER: ""
+
+            # [Mandatory if JF_SMTP_SERVER is set]
+            # The username required for authenticating with the SMTP server.
+            # JF_SMTP_USER: ""
+
+            # [Mandatory if JF_SMTP_SERVER is set]
+            # The password associated with the username required for authentication with the SMTP server.
+            # JF_SMTP_PASSWORD: ""
 
             ###########################################################################
             ##   If your project uses a 'frogbot-config.yml' file, you should define ##
             ##   the following variables inside the file, instead of here.           ##
             ###########################################################################
-
-            # [Mandatory if the two conditions below are met]
-            # 1. The project uses yarn 2, NuGet, or .NET to download its dependencies
-            # 2. The `installCommand` variable isn't set in your frogbot-config.yml file.
-            #
-            # The command that installs the project dependencies (e.g "nuget restore")
-            # JF_INSTALL_DEPS_CMD: ""
-
+
             # [Optional, default: "."]
             # Relative path to the root of the project in the Git repository
             # JF_WORKING_DIR: path/to/project/dir
@@ -273,53 +279,26 @@ jobs:
             # Fails the Frogbot task if any security issue is found.
             # JF_FAIL: "FALSE"
 
-            # [Optional]
-            # Relative path to a Pip requirements.txt file. If not set, the Python project's dependencies are determined and scanned using the project setup.py file.
-            # JF_REQUIREMENTS_FILE: ""
-
-            # [Optional, Default: "TRUE"]
-            # Use Gradle wrapper.
-            # JF_USE_WRAPPER: "FALSE"
-
             # [Optional]
             # Frogbot will download the project dependencies if they're not cached locally. To download the
             # dependencies from a virtual repository in Artifactory, set the name of the repository. There's no
             # need to set this value, if it is set in the frogbot-config.yml file.
             # JF_DEPS_REPO: ""
-
-            # [Optional]
-            # Template for the branch name generated by Frogbot when creating pull requests with fixes.
-            # The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique.
-            # The template can optionally include the ${IMPACTED_PACKAGE} and ${FIX_VERSION} variables.
-            # JF_BRANCH_NAME_TEMPLATE: "frogbot-${IMPACTED_PACKAGE}-${BRANCH_NAME_HASH}"
-
-            # [Optional]
-            # Template for the commit message generated by Frogbot when creating pull requests with fixes
-            # The template can optionally include the ${IMPACTED_PACKAGE} and ${FIX_VERSION} variables.
-            # JF_COMMIT_MESSAGE_TEMPLATE: "Upgrade ${IMPACTED_PACKAGE} to ${FIX_VERSION}"
-
-            # [Optional]
-            # Template for the pull request title generated by Frogbot when creating pull requests with fixes.
-            # The template can optionally include the ${IMPACTED_PACKAGE} and ${FIX_VERSION} variables.
-            # JF_PULL_REQUEST_TITLE_TEMPLATE: "[🐸 Frogbot] Upgrade ${IMPACTED_PACKAGE} to ${FIX_VERSION}"
-
-            # [Optional, Default: "FALSE"]
-            # If TRUE, Frogbot creates a single pull request with all the fixes.
-            # If FALSE, Frogbot creates a separate pull request for each fix.
-            # JF_GIT_AGGREGATE_FIXES: "FALSE"
-
+
             # [Optional, Default: "FALSE"]
             # Handle vulnerabilities with fix versions only
             # JF_FIXABLE_ONLY: "TRUE"
 
             # [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
+            # The following values are accepted: Low, Medium, High or Critical
             # JF_MIN_SEVERITY: ""
 
-            # [Optional, Default: eco-system+frogbot@jfrog.com]
-            # Set the email of the commit author
-            # JF_GIT_EMAIL_AUTHOR: ""
+            # [Mandatory if JF_SMTP_SERVER is set]
+            # List of email addresses to receive emails about secrets that has been detected in a pull request scan.
+            # The list should be seperated by commas.
+            # JF_EMAIL_RECEIVERS: ""
+
           inputs:
              script: |
                 getFrogbotScriptPath=$(if [ -z "$JF_RELEASES_REPO" ]; then echo "https://releases.jfrog.io"; else echo "${JF_URL}/artifactory/${JF_RELEASES_REPO}"; fi)