github.com/jfrog/jfrog-cli-core/v2@v2.51.0/.github/workflows/frogbot-scan-repository.yml (about) 1 name: "Frogbot Scan Repository" 2 on: 3 workflow_dispatch: 4 schedule: 5 # The repository will be scanned once a day at 00:00 GMT. 6 - cron: "0 0 * * *" 7 permissions: 8 contents: write 9 pull-requests: write 10 security-events: write 11 jobs: 12 scan-repository: 13 runs-on: ubuntu-latest 14 strategy: 15 matrix: 16 # The repository scanning will be triggered periodically on the following branches. 17 branch: [ "dev" ] 18 steps: 19 - uses: jfrog/frogbot@v2 20 env: 21 JFROG_CLI_LOG_LEVEL: "DEBUG" 22 # [Mandatory] 23 # JFrog platform URL (This functionality requires version 3.29.0 or above of Xray) 24 JF_URL: ${{ secrets.FROGBOT_URL }} 25 26 # [Mandatory if JF_USER and JF_PASSWORD are not provided] 27 # JFrog access token with 'read' permissions on Xray service 28 JF_ACCESS_TOKEN: ${{ secrets.FROGBOT_ACCESS_TOKEN }} 29 30 # [Mandatory if JF_ACCESS_TOKEN is not provided] 31 # JFrog username with 'read' permissions for Xray. Must be provided with JF_PASSWORD 32 # JF_USER: ${{ secrets.JF_USER }} 33 34 # [Mandatory if JF_ACCESS_TOKEN is not provided] 35 # JFrog password. Must be provided with JF_USER 36 # JF_PASSWORD: ${{ secrets.JF_PASSWORD }} 37 38 # [Mandatory] 39 # The GitHub token is automatically generated for the job 40 JF_GIT_TOKEN: ${{ secrets.GITHUB_TOKEN }} 41 42 # [Mandatory] 43 # The name of the branch on which Frogbot will perform the scan 44 JF_GIT_BASE_BRANCH: ${{ matrix.branch }} 45 46 # [Optional, default: https://api.github.com] 47 # API endpoint to GitHub 48 # JF_GIT_API_ENDPOINT: https://github.example.com 49 50 # [Optional] 51 # By default, the Frogbot workflows download the Frogbot executable as well as other tools 52 # needed from https://releases.jfrog.io 53 # If the machine that runs Frogbot has no access to the internet, follow these steps to allow the 54 # executable to be downloaded from an Artifactory instance, which the machine has access to: 55 # 56 # 1. Login to the Artifactory UI, with a user who has admin credentials. 57 # 2. Create a Remote Repository with the following properties set. 58 # Under the 'Basic' tab: 59 # Package Type: Generic 60 # URL: https://releases.jfrog.io 61 # Under the 'Advanced' tab: 62 # Uncheck the 'Store Artifacts Locally' option 63 # 3. Set the value of the 'JF_RELEASES_REPO' variable with the Repository Key you created. 64 # JF_RELEASES_REPO: "" 65 66 ########################################################################## 67 ## If your project uses a 'frogbot-config.yml' file, you can define ## 68 ## the following variables inside the file, instead of here. ## 69 ########################################################################## 70 71 # [Optional, default: "."] 72 # Relative path to the root of the project in the Git repository 73 # JF_WORKING_DIR: path/to/project/dir 74 75 # [Optional] 76 # Xray Watches. Learn more about them here: https://www.jfrog.com/confluence/display/JFROG/Configuring+Xray+Watches 77 # JF_WATCHES: <watch-1>,<watch-2>...<watch-n> 78 79 # [Optional] 80 # JFrog project. Learn more about it here: https://www.jfrog.com/confluence/display/JFROG/Projects 81 # JF_PROJECT: <project-key> 82 83 # [Optional, default: "TRUE"] 84 # Fails the Frogbot task if any security issue is found. 85 # JF_FAIL: "FALSE" 86 87 # [Optional] 88 # Frogbot will download the project dependencies, if they're not cached locally. To download the 89 # dependencies from a virtual repository in Artifactory, set the name of the repository. There's no 90 # need to set this value, if it is set in the frogbot-config.yml file. 91 # JF_DEPS_REPO: "" 92 93 # [Optional] 94 # Template for the branch name generated by Frogbot when creating pull requests with fixes. 95 # The template must include ${BRANCH_NAME_HASH}, to ensure that the generated branch name is unique. 96 # The template can optionally include the ${IMPACTED_PACKAGE} and ${FIX_VERSION} variables. 97 # JF_BRANCH_NAME_TEMPLATE: "frogbot-${IMPACTED_PACKAGE}-${BRANCH_NAME_HASH}" 98 99 # [Optional] 100 # Template for the commit message generated by Frogbot when creating pull requests with fixes 101 # The template can optionally include the ${IMPACTED_PACKAGE} and ${FIX_VERSION} variables. 102 # JF_COMMIT_MESSAGE_TEMPLATE: "Upgrade ${IMPACTED_PACKAGE} to ${FIX_VERSION}" 103 104 # [Optional] 105 # Template for the pull request title generated by Frogbot when creating pull requests with fixes. 106 # The template can optionally include the ${IMPACTED_PACKAGE} and ${FIX_VERSION} variables. 107 # JF_PULL_REQUEST_TITLE_TEMPLATE: "[🐸 Frogbot] Upgrade ${IMPACTED_PACKAGE} to ${FIX_VERSION}" 108 109 # [Optional, Default: "FALSE"] 110 # If TRUE, Frogbot creates a single pull request with all the fixes. 111 # If FALSE, Frogbot creates a separate pull request for each fix. 112 # JF_GIT_AGGREGATE_FIXES: "FALSE" 113 114 # [Optional, Default: "FALSE"] 115 # Handle vulnerabilities with fix versions only 116 # JF_FIXABLE_ONLY: "TRUE" 117 118 # [Optional] 119 # Set the minimum severity for vulnerabilities that should be fixed and commented on in pull requests 120 # The following values are accepted: Low, Medium, High or Critical 121 # JF_MIN_SEVERITY: "" 122 123 # [Optional, Default: eco-system+frogbot@jfrog.com] 124 # Set the email of the commit author 125 # JF_GIT_EMAIL_AUTHOR: ""