From 3f1e9886b8fb7eca66afa34deebe25e1d5600464 Mon Sep 17 00:00:00 2001 From: Karl Heinz Struggl Date: Fri, 27 Sep 2024 16:06:11 +0200 Subject: [PATCH 1/2] adds config+action to warn about risky PR changes --- .github/file-filters.yml | 4 ++ .../workflows/changes-in-high-risk-code.yml | 49 +++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 .github/file-filters.yml create mode 100644 .github/workflows/changes-in-high-risk-code.yml diff --git a/.github/file-filters.yml b/.github/file-filters.yml new file mode 100644 index 0000000000..823f3b5032 --- /dev/null +++ b/.github/file-filters.yml @@ -0,0 +1,4 @@ +# This is used by the action https://github.com/dorny/paths-filter + +high_risk_code: &high_risk_code + - ".github/file-filters.yml" diff --git a/.github/workflows/changes-in-high-risk-code.yml b/.github/workflows/changes-in-high-risk-code.yml new file mode 100644 index 0000000000..64decbe48f --- /dev/null +++ b/.github/workflows/changes-in-high-risk-code.yml @@ -0,0 +1,49 @@ +name: Changes In High Risk Code +on: + pull_request: + +# https://docs.github.com/en/actions/using-jobs/using-concurrency#example-using-a-fallback-value +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + files-changed: + name: Detect changed files + runs-on: ubuntu-latest + # Map a step output to a job output + outputs: + high_risk_code: ${{ steps.changes.outputs.high_risk_code }} + high_risk_code_files: ${{ steps.changes.outputs.high_risk_code_files }} + steps: + - uses: actions/checkout@v4 + - name: Get changed files + id: changes + uses: dorny/paths-filter@de90cc6fb38fc0963ad72b210f1f284cd68cea36 # v3.0.2 + with: + token: ${{ github.token }} + filters: .github/file-filters.yml + + # Enable listing of files matching each filter. + # Paths to files will be available in `${FILTER_NAME}_files` output variable. + list-files: csv + + validate-high-risk-code: + if: needs.files-changed.outputs.high_risk_code == 'true' + needs: files-changed + runs-on: ubuntu-latest + steps: + - name: Comment on PR to notify of changes in high risk files + uses: actions/github-script@v7 + env: + high_risk_code: ${{ needs.files-changed.outputs.high_risk_code_files }} + with: + script: | + const highRiskFiles = process.env.high_risk_code; + const fileList = highRiskFiles.split(',').map(file => `- [ ] ${file}`).join('\n'); + github.rest.issues.createComment({ + issue_number: context.issue.number, + owner: context.repo.owner, + repo: context.repo.repo, + body: `### 🚨 Detected changes in high risk code 🚨 \n High-risk code has higher potential to break the SDK and may be hard to test. To prevent severe bugs, apply the rollout process for releasing such changes and be extra careful when changing and reviewing these files:\n ${fileList}` + }) From 2023f7706bf3eb8b34002c594860e1b604a9bc18 Mon Sep 17 00:00:00 2001 From: Giancarlo Buenaflor Date: Mon, 7 Oct 2024 13:10:39 +0200 Subject: [PATCH 2/2] Add risky files --- .github/file-filters.yml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/file-filters.yml b/.github/file-filters.yml index 823f3b5032..f86f14edad 100644 --- a/.github/file-filters.yml +++ b/.github/file-filters.yml @@ -1,4 +1,8 @@ # This is used by the action https://github.com/dorny/paths-filter high_risk_code: &high_risk_code - - ".github/file-filters.yml" + - "flutter/lib/src/span_frame_metrics_collector.dart" + - "flutter/lib/src/integrations/native_app_start_integration.dart" + - "flutter/android/src/main/kotlin/io/sentry/flutter/SentryFlutterPlugin.kt" + - "flutter/ios/Classes/SentryFlutterPluginApple.swift" +