Skip to content

Commit 5124d3a

Browse files
asafcjfrogasafcjfrog
authored
Update scan-pull-request-full-template.md
1 parent 5b4aee3 commit 5124d3a

File tree

1 file changed

+5
-158
lines changed

1 file changed

+5
-158
lines changed

‎jfrog-applications/jfrog-applications/frogbot/setup-frogbot/setup-frogbot-using-github-actions/scan-pull-request-full-template.md‎

Lines changed: 5 additions & 158 deletions
Original file line numberDiff line numberDiff line change
@@ -1,161 +1,8 @@
11
# Scan Pull Request Full Template
22

3-
Here you can find the full template for Frogbot pull request scan workflow:
3+
**The JFrog Security documentation has a new home!**\
4+
You can now find it [here](https://jfrog.com/help/p/security-home), including sections on:
45

5-
```yaml
6-
name: "Frogbot Scan Pull Request"
7-
on:
8-
pull_request_target:
9-
types: [opened, synchronize]
10-
permissions:
11-
pull-requests: write
12-
contents: read
13-
# [Mandatory If using OIDC authentication protocol instead of JF_ACCESS_TOKEN]
14-
# id-token: write
15-
jobs:
16-
scan-pull-request:
17-
runs-on: ubuntu-latest
18-
# A pull request needs to be approved before Frogbot scans it. Any GitHub user who is associated with the
19-
# "frogbot" GitHub environment can approve the pull request to be scanned.
20-
environment: frogbot
21-
steps:
22-
- uses: jfrog/frogbot@v2
23-
env:
24-
# [Mandatory]
25-
# JFrog platform URL
26-
JF_URL: ${{ secrets.JF_URL }}
27-
28-
# [Mandatory if JF_USER and JF_PASSWORD are not provided]
29-
# JFrog access token with 'read' permissions on Xray service
30-
JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }}
31-
32-
# [Mandatory if JF_ACCESS_TOKEN is not provided]
33-
# JFrog username with 'read' permissions for Xray. Must be provided with JF_PASSWORD
34-
# JF_USER: ${{ secrets.JF_USER }}
35-
36-
# [Mandatory if JF_ACCESS_TOKEN is not provided]
37-
# JFrog password. Must be provided with JF_USER
38-
# JF_PASSWORD: ${{ secrets.JF_PASSWORD }}
39-
40-
# [Mandatory]
41-
# The GitHub token is automatically generated for the job
42-
JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
43-
44-
# [Optional, default: https://api.github.com]
45-
# API endpoint to GitHub
46-
# JF_GIT_API_ENDPOINT: https://github.example.com
47-
48-
# [Optional]
49-
# By default, the Frogbot workflows download the Frogbot executable as well as other tools
50-
# needed from https://releases.jfrog.io
51-
# If the machine that runs Frogbot has no access to the internet, follow these steps to allow the
52-
# executable to be downloaded from an Artifactory instance, which the machine has access to:
53-
#
54-
# 1. Login to the Artifactory UI, with a user who has admin credentials.
55-
# 2. Create a Remote Repository with the following properties set.
56-
# Under the 'Basic' tab:
57-
# Package Type: Generic
58-
# URL: https://releases.jfrog.io
59-
# Under the 'Advanced' tab:
60-
# Uncheck the 'Store Artifacts Locally' option
61-
# 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created.
62-
# JF_RELEASES_REPO: ""
63-
64-
# [Optional]
65-
# Configure the SMTP server to enable Frogbot to send emails with detected secrets in pull request scans.
66-
# SMTP server URL including should the relevant port: (Example: smtp.server.com:8080)
67-
# JF_SMTP_SERVER: ""
68-
69-
# [Mandatory if JF_SMTP_SERVER is set]
70-
# The username required for authenticating with the SMTP server.
71-
# JF_SMTP_USER: ""
72-
73-
# [Mandatory if JF_SMTP_SERVER is set]
74-
# The password associated with the username required for authentication with the SMTP server.
75-
# JF_SMTP_PASSWORD: ""
76-
77-
##########################################################################
78-
## If your project uses a 'frogbot-config.yml' file, you can define ##
79-
## the following variables inside the file, instead of here. ##
80-
##########################################################################
81-
82-
# [Mandatory if the two conditions below are met]
83-
# 1. The project uses yarn 2, NuGet or .NET Core to download its dependencies
84-
# 2. The `installCommand` variable isn't set in your frogbot-config.yml file.
85-
#
86-
# The command that installs the project dependencies (e.g "nuget restore")
87-
# JF_INSTALL_DEPS_CMD: ""
88-
89-
# [Optional, default: "."]
90-
# Relative path to the root of the project in the Git repository. If left empty (without providing "." yourself as default), a recursive scan is triggered from the root directory of the project.
91-
# JF_WORKING_DIR: path/to/project/dir
92-
93-
# [Default: "*git*;*node_modules*;*target*;*venv*;*test*"]
94-
# List of exclusion patterns (utilizing wildcards) for excluding paths in the source code of the Git repository during SCA scans.
95-
# JF_PATH_EXCLUSIONS: "*git*;*node_modules*;*target*;*venv*;*test*"
96-
97-
# [Optional]
98-
# Xray Watches. Learn more about them here: https://www.jfrog.com/confluence/display/JFROG/Configuring+Xray+Watches
99-
# JF_WATCHES: <watch-1>,<watch-2>...<watch-n>
100-
101-
# [Optional]
102-
# JFrog project. Learn more about it here: https://www.jfrog.com/confluence/display/JFROG/Projects
103-
# JF_PROJECT: <project-key>
104-
105-
# [Optional, default: "FALSE"]
106-
# Displays all existing vulnerabilities, including the ones that were added by the pull request.
107-
# JF_INCLUDE_ALL_VULNERABILITIES: "TRUE"
108-
109-
# [Optional, default: "FALSE"]
110-
# When adding new comments on pull requests, keep old comments that were added by previous scans.
111-
# JF_AVOID_PREVIOUS_PR_COMMENTS_DELETION: "TRUE"
112-
113-
# [Optional, default: "TRUE"]
114-
# Fails the Frogbot task if any security issue is found.
115-
# JF_FAIL: "FALSE"
116-
117-
# [Optional]
118-
# Frogbot will download the project dependencies if they're not cached locally. To download the
119-
# dependencies from a virtual repository in Artifactory, set the name of the repository. There's no
120-
# need to set this value, if it is set in the frogbot-config.yml file.
121-
# JF_DEPS_REPO: ""
122-
123-
# [Optional, Default: "FALSE"]
124-
# If TRUE, Frogbot creates a single pull request with all the fixes.
125-
# If false, Frogbot creates a separate pull request for each fix.
126-
# JF_GIT_AGGREGATE_FIXES: "FALSE"
127-
128-
# [Optional, Default: "FALSE"]
129-
# Handle vulnerabilities with fix versions only
130-
# JF_FIXABLE_ONLY: "TRUE"
131-
132-
# [Optional]
133-
# Set the minimum severity for vulnerabilities that should be fixed and commented on in pull requests
134-
# The following values are accepted: Low, Medium, High or Critical
135-
# JF_MIN_SEVERITY: ""
136-
137-
# [Optional]
138-
# List of comma-separated(,) email addresses to receive email notifications about secrets
139-
# detected during pull request scanning. The notification is also sent to the email set
140-
# in the committer git profile regardless of whether this variable is set or not.
141-
# JF_EMAIL_RECEIVERS: ""
142-
143-
# [Optional]
144-
# Set the list of allowed licenses
145-
# The full list of licenses can be found in:
146-
# https://github.com/jfrog/frogbot/blob/master/docs/licenses.md
147-
# JF_ALLOWED_LICENSES: "MIT, Apache-2.0"
148-
149-
# [Optional]
150-
# Avoid adding extra info to pull request comments. that isn't related to the scan findings.
151-
# JF_AVOID_EXTRA_MESSAGES: "TRUE"
152-
153-
# [Optional]
154-
# Add a title to pull request comments generated by Frogbot.
155-
# JF_PR_COMMENT_TITLE: ""
156-
157-
# [Mandatory if using OIDC authentication protocol instead of JF_ACCESS_TOKEN]
158-
# Insert to oidc-provider-name the 'Provider Name' defined in the OIDC integration configured in the JPD
159-
# with:
160-
# oidc-provider-name: ""
161-
```
6+
* [CLI](https://jfrog.com/help/r/jfrog-security-user-guide/developers/cli)
7+
* [Frogbot](https://jfrog.com/help/r/jfrog-security-user-guide/developers/frogbot)
8+
* [IDEs](https://jfrog.com/help/r/jfrog-security-user-guide/developers/ides)

0 commit comments

Comments
 (0)