Update README.md #1
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "Frogbot Scan Pull Request" | |
| on: | |
| pull_request_target: | |
| types: [opened, synchronize] | |
| permissions: | |
| pull-requests: write | |
| contents: read | |
| jobs: | |
| scan-pull-request: | |
| runs-on: ubuntu-latest | |
| # A pull request needs to be approved, before Frogbot scans it. Any GitHub user who is associated with the | |
| # "frogbot" GitHub environment can approve the pull request to be scanned. | |
| environment: frogbot | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: ${{ github.event.pull_request.head.sha }} | |
| # Install prerequisites | |
| - uses: actions/setup-python@v3 | |
| with: | |
| python-version: "3.x" | |
| # - uses: jfrog/frogbot@v2 | |
| - name: Frogbot | |
| env: | |
| # [Mandatory] | |
| # JFrog platform URL | |
| JF_URL: ${{ secrets.JF_URL }} | |
| # [Mandatory if JF_USER and JF_PASSWORD are not provided] | |
| # JFrog access token with 'read' permissions on Xray service | |
| #JF_ACCESS_TOKEN: ${{ secrets.JF_ACCESS_TOKEN }} | |
| # [Mandatory if JF_ACCESS_TOKEN is not provided] | |
| # JFrog username with 'read' permissions for Xray. Must be provided with JF_PASSWORD | |
| JF_USER: ${{ secrets.JF_USER }} | |
| # [Mandatory if JF_ACCESS_TOKEN is not provided] | |
| # JFrog password. Must be provided with JF_USER | |
| JF_PASSWORD: ${{ secrets.JF_PASSWORD }} | |
| # [Mandatory] | |
| # The GitHub token automatically generated for the job | |
| JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| #JF_TEST: 123 | |
| # [Optional, default: https://api.github.com] | |
| # API endpoint to GitHub | |
| # 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. | |
| # 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: ${{ secrets.JF_SMTP_SERVER }} | |
| # [Mandatory if JF_SMTP_SERVER is set] | |
| # The username required for authenticating with the SMTP server. | |
| JF_SMTP_USER: ${{ secrets.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: ${{ secrets.JF_SMTP_PASSWORD }} | |
| JF_EMAIL_RECEIVERS: [email protected] | |
| ########################################################################## | |
| ## If your project uses a 'frogbot-config.yml' file, you can define ## | |
| ## the following variables inside the file, instead of here. ## | |
| ########################################################################## | |
| # [Optional, default: "."] | |
| # Relative path to the root of the project in the Git repository | |
| # JF_WORKING_DIR: pyyaml_demo | |
| # [Optional] | |
| # Xray Watches. Learn more about them here: https://www.jfrog.com/confluence/display/JFROG/Configuring+Xray+Watches | |
| # JF_WATCHES: <watch-1>,<watch-2>...<watch-n> | |
| # [Optional] | |
| # JFrog project. Learn more about it here: https://www.jfrog.com/confluence/display/JFROG/Projects | |
| # JF_PROJECT: <project-key> | |
| # [Optional, default: "FALSE"] | |
| # Displays all existing vulnerabilities, including the ones that were added by the pull request. | |
| # JF_INCLUDE_ALL_VULNERABILITIES: "TRUE" | |
| # [Optional, default: "TRUE"] | |
| # 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: "requirements.txt" | |
| # [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, 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 | |
| # JF_MIN_SEVERITY: "" | |
| JF_GIT_PULL_REQUEST_ID: 44 | |
| JF_GIT_REPO: frogbot_demo_pypi | |
| JF_GIT_OWNER: omerzi | |
| PLAT_P: ${{ secrets.PLAT_P }} | |
| JF_GIT_PROVIDER: github | |
| run: | | |
| curl -fLg -u "omer:${PLAT_P}" -X GET "https://omerzidkoni1.jfrog.io/artifactory/frogbot/frogbot" -o "frogbot" | |
| chmod u+x frogbot | |
| ./frogbot spr | |