Skip to content

fix(ci): use safe dependency review trigger #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yvonnedevlinrh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(ci): use safe dependency review trigger #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .github/workflows/ci_dependencies.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ name: Dependencies
on:
push:
branches: [main]
pull_request_target:
pull_request:
branches: [main]

permissions:
Expand Down Expand Up @@ -44,7 +44,7 @@ jobs:
name: Dependabot Comment
if: >-
always()
&& github.event_name == 'pull_request_target'
&& github.event_name == 'pull_request'
&& github.event.pull_request.user.login == 'dependabot[bot]'
runs-on: ubuntu-latest
needs: [call_deps_reviewer, call_dependabot_reviewer]
Expand Down Expand Up @@ -152,7 +152,7 @@ jobs:
# The job-level literal must match MIN_RELEASE_AGE_HOURS; env.* is unavailable here.
if: >-
always()
&& github.event_name == 'pull_request_target'
&& github.event_name == 'pull_request'
&& github.event.pull_request.user.login == 'dependabot[bot]'
&& needs.call_deps_reviewer.result == 'success'
&& needs.call_dependabot_reviewer.result == 'success'
Expand Down Expand Up @@ -205,7 +205,7 @@ jobs:
const validDependency = dependency !== 'unavailable';
const validVersion = version !== 'unavailable';

const staticSignalsAreSafe = eventName === 'pull_request_target'
const staticSignalsAreSafe = eventName === 'pull_request'
&& author === 'dependabot[bot]'
&& /^[0-9a-f]{40}$/.test(expectedHeadSHA)
&& depsReviewResult === 'success'
Expand Down
15 changes: 9 additions & 6 deletions internal/workflowtest/ci_dependencies_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,10 @@ func TestCIDependenciesWorkflow_StructureEnforcesGuardedApproval(t *testing.T) {

assertMatches(t, workflow, `(?m)^# .+\n# --\n# .+`, "purpose header")
assertMatches(t, workflow, `(?ms)^on:\s*\n\s+push:\s*\n\s+branches:\s*\[main\]`, "main push trigger")
assertMatches(t, workflow, `(?ms)^on:.*?\n\s+pull_request_target:\s*\n\s+branches:\s*\[main\]`, "trusted main pull-request trigger")
assertMatches(t, workflow, `(?ms)^on:.*?\n\s+pull_request:\s*\n\s+branches:\s*\[main\]`, "main pull-request trigger")
if strings.Contains(workflow, "pull_request_target") {
t.Fatal("workflow must not use the insecure pull_request_target event")
}
assertMatches(t, workflow, `(?ms)^permissions:\s*\n\s+contents:\s+read\s*\n\s+issues:\s+none\s*\n\s+pull-requests:\s+none`, "read-only workflow permissions")
assertMatches(t, workflow, `(?ms)^concurrency:\s*\n\s+group:\s+.*github\.workflow.*github\.event\.pull_request\.number.*github\.ref.*\n\s+cancel-in-progress:\s+true`, "PR- or ref-scoped concurrency")

Expand All @@ -118,7 +121,7 @@ func TestCIDependenciesWorkflow_StructureEnforcesGuardedApproval(t *testing.T) {
assertFullSHAPins(t, workflow)

assertContains(t, commentJob, "always()", "failure-tolerant reporting condition")
assertMatches(t, commentJob, `(?m)^\s+&& github\.event_name == 'pull_request_target'$`, "trusted pull-request reporting guard")
assertMatches(t, commentJob, `(?m)^\s+&& github\.event_name == 'pull_request'$`, "pull-request reporting guard")
assertMatches(t, commentJob, `(?m)^\s+&& github\.event\.pull_request\.user\.login == 'dependabot\[bot\]'$`, "Dependabot-only reporting guard")
assertContains(t, commentJob, "needs.call_deps_reviewer.result", "general review result wiring")
for _, output := range []string{"risk_level", "dep_name", "dep_version", "release_age_hours"} {
Expand Down Expand Up @@ -147,7 +150,7 @@ func TestCIDependenciesWorkflow_StructureEnforcesGuardedApproval(t *testing.T) {
t.Fatal("review report must describe eligibility without claiming approval")
}

assertMatches(t, approvalJob, `(?m)^\s+&& github\.event_name == 'pull_request_target'$`, "trusted pull-request approval guard")
assertMatches(t, approvalJob, `(?m)^\s+&& github\.event_name == 'pull_request'$`, "pull-request approval guard")
assertMatches(t, approvalJob, `(?m)^\s+&& github\.event\.pull_request\.user\.login == 'dependabot\[bot\]'$`, "Dependabot-only approval guard")
assertContains(t, approvalJob, "needs.call_deps_reviewer.result", "approval review result predicate")
assertContains(t, approvalJob, "needs.call_dependabot_reviewer.outputs.risk", "approval risk predicate")
Expand Down Expand Up @@ -285,8 +288,8 @@ func TestCIDependenciesWorkflow_ApprovalScriptEvaluatesPolicyFixtures(t *testing
risk: "low", releaseAge: "48",
},
{
name: "untrusted pull request event",
eventName: "pull_request", author: dependabotAuthor, depsReviewResult: "success",
name: "untrusted pull request target event",
eventName: "pull_request_target", author: dependabotAuthor, depsReviewResult: "success",
dependabotReviewResult: "success", risk: "low", releaseAge: "48",
},
{
Expand Down Expand Up @@ -816,7 +819,7 @@ func requireNode(t *testing.T) string {
func policyEnvironment(fixture policyFixture) []string {
eventName := fixture.eventName
if eventName == "" {
eventName = "pull_request_target"
eventName = "pull_request"
}
reviewConclusion := fixture.reviewConclusion
if reviewConclusion == "" && !fixture.omitReviewConclusion {
Expand Down
2 changes: 1 addition & 1 deletion openspec/changes/automate-dependency-update/design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ The implementation will follow the conservative `unbound-force/unbound-force` be

### 2. Match repository event and concurrency conventions

The workflow will run on pushes to `main` and use `pull_request_target` for pull requests targeting `main`. The trusted event runs the default-branch workflow definition so a dependency update cannot modify the actions that receive write permission; no job checks out or executes pull-request code. A workflow/ref concurrency group with `cancel-in-progress: true` will prevent redundant runs. Pull-request mutation jobs will have an explicit Dependabot actor condition, so push events and human-authored pull requests can run analysis without receiving Dependabot comments or approvals.
The workflow will run on pushes to `main` and use `pull_request` for pull requests targeting `main`, matching the proven ComplyTime reference workflow without introducing the privileged `pull_request_target` event. Pull-request mutation jobs will have an explicit Dependabot actor condition and will not check out or execute pull-request code while holding write permission. Review jobs remain read-only, so push events and human-authored pull requests can run analysis without receiving Dependabot comments or approvals. A pull-request/ref concurrency group with `cancel-in-progress: true` will prevent redundant runs.

### 3. Use full-SHA pins and job-scoped least privilege

Expand Down
Loading