From 0fa9aebf7a80a708b28ef2ec13aab720045d16f9 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 18 Feb 2021 12:21:53 +0100 Subject: [PATCH 1/4] Split analysis workflows into CodeQL, FOSSA, Snyk This reverts #934, but takes into account the mistakes that were fixed there. Signed-off-by: Hidde Beydals --- .github/workflows/codeql-analysis.yml | 67 +++++++++++++++++++++++++++ .github/workflows/fossa.yml | 19 ++++++++ .github/workflows/scan.yml | 44 ------------------ .github/workflows/snyk.yml | 24 ++++++++++ 4 files changed, 110 insertions(+), 44 deletions(-) create mode 100644 .github/workflows/codeql-analysis.yml create mode 100644 .github/workflows/fossa.yml delete mode 100644 .github/workflows/scan.yml create mode 100644 .github/workflows/snyk.yml diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml new file mode 100644 index 00000000..18099f2e --- /dev/null +++ b/.github/workflows/codeql-analysis.yml @@ -0,0 +1,67 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '18 10 * * 3' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + language: [ 'go' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] + # Learn more: + # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed + + steps: + - name: Checkout repository + uses: actions/checkout@v2 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + # queries: ./path/to/local/query, your-org/your-repo/queries@main + + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 https://git.io/JvXDl + + # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines + # and modify them (or add more) to build your code if your project + # uses a compiled language + + #- run: | + # make bootstrap + # make release + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/fossa.yml b/.github/workflows/fossa.yml new file mode 100644 index 00000000..074663f5 --- /dev/null +++ b/.github/workflows/fossa.yml @@ -0,0 +1,19 @@ +name: FOSSA + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + scan: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Run FOSSA scan and upload build data + uses: fossa-contrib/fossa-action@v1 + with: + # FOSSA Push-Only API Token + fossa-api-key: 5ee8bf422db1471e0bcf2bcb289185de + github-token: ${{ github.token }} diff --git a/.github/workflows/scan.yml b/.github/workflows/scan.yml deleted file mode 100644 index 63f34b94..00000000 --- a/.github/workflows/scan.yml +++ /dev/null @@ -1,44 +0,0 @@ -name: scan -on: - push: - pull_request: - branches: [main] - -jobs: - analyze: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-go@v2 - with: - go-version: 1.15.x - - name: FOSSA Analysis - if: github.event_name == 'pull_request' - uses: fossa-contrib/fossa-action@v1 - with: - fossa-api-key: 5ee8bf422db1471e0bcf2bcb289185de - github-token: ${{ github.token }} - - name: CodeQL Init - if: github.event_name == 'pull_request' - uses: github/codeql-action/init@v1 - with: - languages: "go" - - name: CodeQL Autobuild - if: github.event_name == 'pull_request' - uses: github/codeql-action/autobuild@v1 - - name: CodeQL Analysis - if: github.event_name == 'pull_request' - uses: github/codeql-action/analyze@v1 - - name: Snyk Init - if: github.event_name == 'push' - uses: snyk/actions/setup@master - - name: Snyk Analysis - if: github.event_name == 'push' - run: snyk test --sarif-file-output=snyk.sarif - env: - SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} - - name: Snyk Upload result to GitHub Code Scanning - if: github.event_name == 'push' - uses: github/codeql-action/upload-sarif@v1 - with: - sarif_file: snyk.sarif diff --git a/.github/workflows/snyk.yml b/.github/workflows/snyk.yml new file mode 100644 index 00000000..88918bf1 --- /dev/null +++ b/.github/workflows/snyk.yml @@ -0,0 +1,24 @@ +name: Snyk + +on: + push: + branches: [main] + pull_request: + branches: [main] + +jobs: + security: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - name: Run Snyk to check for vulnerabilities + uses: snyk/actions/golang@master + continue-on-error: true + env: + SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} + with: + args: --sarif-file-output=snyk.sarif + - name: Upload result to GitHub Code Scanning + uses: github/codeql-action/upload-sarif@v1 + with: + sarif_file: snyk.sarif From 1b5db157b1f635f6ea72d226bc063e595eababd4 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 18 Feb 2021 13:57:21 +0100 Subject: [PATCH 2/4] Align formatting and extensions workflows Signed-off-by: Hidde Beydals --- .github/workflows/bootstrap.yaml | 3 +-- .../workflows/{codeql-analysis.yml => codeql-analysis.yaml} | 0 .github/workflows/docs.yaml | 5 ++--- .github/workflows/e2e.yaml | 6 +++--- .github/workflows/{fossa.yml => fossa.yaml} | 4 ++-- .github/workflows/{rebase.yml => rebase.yaml} | 4 ++-- .github/workflows/release.yaml | 3 +-- .github/workflows/{snyk.yml => snyk.yaml} | 4 ++-- .github/workflows/{update.yml => update.yaml} | 0 docs/internal/release.md | 2 +- 10 files changed, 14 insertions(+), 17 deletions(-) rename .github/workflows/{codeql-analysis.yml => codeql-analysis.yaml} (100%) rename .github/workflows/{fossa.yml => fossa.yaml} (89%) rename .github/workflows/{rebase.yml => rebase.yaml} (93%) rename .github/workflows/{snyk.yml => snyk.yaml} (92%) rename .github/workflows/{update.yml => update.yaml} (100%) diff --git a/.github/workflows/bootstrap.yaml b/.github/workflows/bootstrap.yaml index a2572ac4..15206130 100644 --- a/.github/workflows/bootstrap.yaml +++ b/.github/workflows/bootstrap.yaml @@ -2,8 +2,7 @@ name: bootstrap on: push: - branches: - - '*' + branches: [ '*' ] jobs: github: diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yaml similarity index 100% rename from .github/workflows/codeql-analysis.yml rename to .github/workflows/codeql-analysis.yaml diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 310d7dc0..b0c9ca6d 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,9 +1,8 @@ name: Publish docs via GitHub Pages + on: push: - branches: - - docs* - - main + branches: [ 'docs*', main ] jobs: build: diff --git a/.github/workflows/e2e.yaml b/.github/workflows/e2e.yaml index f1f5b2b4..2b2b0aa8 100644 --- a/.github/workflows/e2e.yaml +++ b/.github/workflows/e2e.yaml @@ -1,10 +1,10 @@ name: e2e on: - pull_request: push: - branches: - - main + branches: [ main ] + pull_request: + branches: [ main ] jobs: kind: diff --git a/.github/workflows/fossa.yml b/.github/workflows/fossa.yaml similarity index 89% rename from .github/workflows/fossa.yml rename to .github/workflows/fossa.yaml index 074663f5..52feed38 100644 --- a/.github/workflows/fossa.yml +++ b/.github/workflows/fossa.yaml @@ -2,9 +2,9 @@ name: FOSSA on: push: - branches: [main] + branches: [ main ] pull_request: - branches: [main] + branches: [ main ] jobs: scan: diff --git a/.github/workflows/rebase.yml b/.github/workflows/rebase.yaml similarity index 93% rename from .github/workflows/rebase.yml rename to .github/workflows/rebase.yaml index 74a9049a..623b0fbe 100644 --- a/.github/workflows/rebase.yml +++ b/.github/workflows/rebase.yaml @@ -2,9 +2,9 @@ name: rebase on: pull_request: - types: [opened] + types: [ opened ] issue_comment: - types: [created] + types: [ created ] jobs: rebase: diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 5f360131..106bb666 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -2,8 +2,7 @@ name: release on: push: - tags: - - '*' + tags: [ '*' ] jobs: goreleaser: diff --git a/.github/workflows/snyk.yml b/.github/workflows/snyk.yaml similarity index 92% rename from .github/workflows/snyk.yml rename to .github/workflows/snyk.yaml index 88918bf1..2cdfdbfa 100644 --- a/.github/workflows/snyk.yml +++ b/.github/workflows/snyk.yaml @@ -2,9 +2,9 @@ name: Snyk on: push: - branches: [main] + branches: [ main ] pull_request: - branches: [main] + branches: [ main ] jobs: security: diff --git a/.github/workflows/update.yml b/.github/workflows/update.yaml similarity index 100% rename from .github/workflows/update.yml rename to .github/workflows/update.yaml diff --git a/docs/internal/release.md b/docs/internal/release.md index 96ecc537..0910a181 100644 --- a/docs/internal/release.md +++ b/docs/internal/release.md @@ -130,7 +130,7 @@ Upgrade procedure: `fluxcd/flux2`: -1. Update the `github.com/fluxcd/*-controller/api` version in `flux2/go.mod` (automated with [GitHub Actions](../../.github/workflows/update.yml)) +1. Update the `github.com/fluxcd/*-controller/api` version in `flux2/go.mod` (automated with [GitHub Actions](../../.github/workflows/update.yaml)) 1. Update the `github.com/fluxcd/pkg/*` version in `flux2/go.mod` 1. Update the `k8s.io/*` and `github.com/fluxcd/pkg/runtime` version in `flux2/go.mod` From 7eab649abc0c1d503222a43b4ed80a1ae91c22f7 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 18 Feb 2021 14:54:01 +0100 Subject: [PATCH 3/4] Bundle CodeQL, FOSSA, Snyk as jobs in workflow Signed-off-by: Hidde Beydals --- .github/workflows/codeql-analysis.yaml | 67 -------------------------- .github/workflows/fossa.yaml | 19 -------- .github/workflows/scan.yaml | 55 +++++++++++++++++++++ .github/workflows/snyk.yaml | 24 --------- 4 files changed, 55 insertions(+), 110 deletions(-) delete mode 100644 .github/workflows/codeql-analysis.yaml delete mode 100644 .github/workflows/fossa.yaml create mode 100644 .github/workflows/scan.yaml delete mode 100644 .github/workflows/snyk.yaml diff --git a/.github/workflows/codeql-analysis.yaml b/.github/workflows/codeql-analysis.yaml deleted file mode 100644 index 18099f2e..00000000 --- a/.github/workflows/codeql-analysis.yaml +++ /dev/null @@ -1,67 +0,0 @@ -# For most projects, this workflow file will not need changing; you simply need -# to commit it to your repository. -# -# You may wish to alter this file to override the set of languages analyzed, -# or to provide custom queries or build logic. -# -# ******** NOTE ******** -# We have attempted to detect the languages in your repository. Please check -# the `language` matrix defined below to confirm you have the correct set of -# supported CodeQL languages. -# -name: "CodeQL" - -on: - push: - branches: [ main ] - pull_request: - # The branches below must be a subset of the branches above - branches: [ main ] - schedule: - - cron: '18 10 * * 3' - -jobs: - analyze: - name: Analyze - runs-on: ubuntu-latest - - strategy: - fail-fast: false - matrix: - language: [ 'go' ] - # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ] - # Learn more: - # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed - - steps: - - name: Checkout repository - uses: actions/checkout@v2 - - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v1 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - # queries: ./path/to/local/query, your-org/your-repo/queries@main - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@v1 - - # ℹī¸ Command-line programs to run using the OS shell. - # 📚 https://git.io/JvXDl - - # ✏ī¸ If the Autobuild fails above, remove it and uncomment the following three lines - # and modify them (or add more) to build your code if your project - # uses a compiled language - - #- run: | - # make bootstrap - # make release - - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/fossa.yaml b/.github/workflows/fossa.yaml deleted file mode 100644 index 52feed38..00000000 --- a/.github/workflows/fossa.yaml +++ /dev/null @@ -1,19 +0,0 @@ -name: FOSSA - -on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - -jobs: - scan: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - name: Run FOSSA scan and upload build data - uses: fossa-contrib/fossa-action@v1 - with: - # FOSSA Push-Only API Token - fossa-api-key: 5ee8bf422db1471e0bcf2bcb289185de - github-token: ${{ github.token }} diff --git a/.github/workflows/scan.yaml b/.github/workflows/scan.yaml new file mode 100644 index 00000000..57cbeb9f --- /dev/null +++ b/.github/workflows/scan.yaml @@ -0,0 +1,55 @@ +name: Scan + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + schedule: + - cron: '18 10 * * 3' + +jobs: + fossa: + name: FOSSA + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Run FOSSA scan and upload build data + uses: fossa-contrib/fossa-action@v1 + with: + # FOSSA Push-Only API Token + fossa-api-key: 5ee8bf422db1471e0bcf2bcb289185de + github-token: ${{ github.token }} + + snyk: + name: Snyk + runs-on: ubuntu-latest + if: ${{ github.repository_owner == 'fluxcd' }} + steps: + - uses: actions/checkout@v2 + - name: Run Snyk to check for vulnerabilities + uses: snyk/actions/golang@master + continue-on-error: true + env: + SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} + with: + args: --sarif-file-output=snyk.sarif + - name: Upload result to GitHub Code Scanning + uses: github/codeql-action/upload-sarif@v1 + with: + sarif_file: snyk.sarif + + codeql: + name: CodeQL + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + - name: Initialize CodeQL + uses: github/codeql-action/init@v1 + with: + languages: go + - name: Autobuild + uses: github/codeql-action/autobuild@v1 + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v1 diff --git a/.github/workflows/snyk.yaml b/.github/workflows/snyk.yaml deleted file mode 100644 index 2cdfdbfa..00000000 --- a/.github/workflows/snyk.yaml +++ /dev/null @@ -1,24 +0,0 @@ -name: Snyk - -on: - push: - branches: [ main ] - pull_request: - branches: [ main ] - -jobs: - security: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - name: Run Snyk to check for vulnerabilities - uses: snyk/actions/golang@master - continue-on-error: true - env: - SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }} - with: - args: --sarif-file-output=snyk.sarif - - name: Upload result to GitHub Code Scanning - uses: github/codeql-action/upload-sarif@v1 - with: - sarif_file: snyk.sarif From ff78af5808eef4266b195abec5a0f0c3b82711f3 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 18 Feb 2021 15:37:24 +0100 Subject: [PATCH 4/4] Run bootstrap for trusted PRs Signed-off-by: Hidde Beydals --- .github/workflows/bootstrap.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/workflows/bootstrap.yaml b/.github/workflows/bootstrap.yaml index 15206130..90670e5b 100644 --- a/.github/workflows/bootstrap.yaml +++ b/.github/workflows/bootstrap.yaml @@ -2,11 +2,14 @@ name: bootstrap on: push: - branches: [ '*' ] + branches: [ main ] + pull_request: + branches: [ main ] jobs: github: runs-on: ubuntu-latest + if: ${{ github.repository_owner == 'fluxcd' }} steps: - name: Checkout uses: actions/checkout@v2