security-scan #102
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
| # Copyright 2021 Collate | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| name: security-scan | |
| on: | |
| schedule: | |
| - cron: '0 0 */2 * *' | |
| workflow_dispatch: | |
| jobs: | |
| security-scan: | |
| runs-on: ubuntu-latest | |
| environment: security-scan | |
| env: | |
| SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} | |
| SNYK_ORGANIZATION: ${{ secrets.SNYK_ORGANIZATION_ID }} | |
| steps: | |
| - name: Free Disk Space (Ubuntu) | |
| uses: jlumbroso/free-disk-space@main | |
| with: | |
| tool-cache: false | |
| android: true | |
| dotnet: true | |
| haskell: true | |
| large-packages: false | |
| docker-images: true | |
| swap-storage: true | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python 3.9 | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.9 | |
| - name: Set up JDK 17 | |
| uses: actions/setup-java@v3 | |
| with: | |
| java-version: '17' | |
| distribution: 'temurin' | |
| - name: Install Ubuntu dependencies | |
| run: | | |
| # stop relying on apt cache of GitHub runners | |
| sudo apt-get update | |
| sudo apt-get install -y unixodbc-dev python3-venv librdkafka-dev gcc libsasl2-dev build-essential libssl-dev libffi-dev \ | |
| librdkafka-dev unixodbc-dev libevent-dev wkhtmltopdf libkrb5-dev | |
| # Install and Authenticate to Snyk | |
| - name: Install Snyk & Authenticate | |
| run: | | |
| sudo make install_antlr_cli | |
| sudo npm install -g snyk | |
| snyk auth ${SNYK_TOKEN} | |
| snyk config set org=${SNYK_ORGANIZATION} | |
| - name: Install Python dependencies | |
| run: | | |
| python3 -m venv env | |
| source env/bin/activate | |
| make install_all install_apis | |
| - name: Maven build | |
| id: maven-build | |
| continue-on-error: true | |
| run: mvn -DskipTests clean install | |
| - name: Run Scan | |
| id: security-report | |
| if: steps.maven-build.outcome == 'success' | |
| continue-on-error: true | |
| run: | | |
| source env/bin/activate | |
| make snyk-report | |
| - name: Slack on Failure | |
| if: steps.security-report.outcome != 'success' | |
| uses: slackapi/slack-github-action@v1.23.0 | |
| with: | |
| channel-id: ${{ secrets.SLACK_CHANNEL_IDS }} | |
| payload: | | |
| { | |
| "text": "🚨 Security report failed, please check it <https://github.com/open-metadata/OpenMetadata/actions/runs/${{ github.run_id }}|here>. 🚨" | |
| } | |
| env: | |
| SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }} | |
| - name: Slack on Success | |
| if: steps.security-report.outcome == 'success' | |
| uses: slackapi/slack-github-action@v1.23.0 | |
| with: | |
| channel-id: ${{ secrets.SLACK_CHANNEL_IDS }} | |
| payload: | | |
| { | |
| "text": "🟢 Security report generated for OpenMetadata Repo , please check it <https://github.com/open-metadata/OpenMetadata/actions/runs/${{ github.run_id }}|here>." | |
| } | |
| env: | |
| SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }} | |
| - name: Upload Snyk Report HTML files | |
| if: steps.security-report.outcome == 'success' | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: security-report | |
| path: security-report | |
| - name: Force failure | |
| if: steps.maven-build.outcome != 'success' || steps.security-report.outcome != 'success' | |
| run: | | |
| exit 1 |