mirror of
https://github.com/alkimake/paperclip.git
synced 2026-06-14 01:50:39 +09:00
Fixes #6470 ## Thinking Path > - Paperclip is an open-source AI agent platform receiving a high volume of community PRs — currently 2,398 open > - The contributor experience is broken: PRs sit for months with no feedback, contributors don't know why they're stuck, and maintainers spend review time on PRs that are missing basics > - Common problems: no linked issue, no test coverage, incomplete PR template, manually-edited lockfile — all catchable before human review > - At the same time, accepting untrusted PRs from unknown contributors is a real attack surface: malicious packages, secret injection, tampering with CI scripts, and code touching the sensitive paths from the April security advisories > - This PR adds automated gates that run on every PR: quality failures get a clear comment telling contributors exactly what to fix, security concerns are silently flagged as draft advisories and block merge via a pending check run > - The benefit is a dramatically faster feedback loop for good-faith contributors and a meaningful security layer for the maintainers reviewing them ## What Changed - **`.github/workflows/commitperclip-review.yml`** — new workflow using `pull_request_target` (runs in base branch context, has secrets, never executes PR code). Runs quality gates + security gates on every PR open/update. - **`.github/dependabot.yml`** — weekly automated dependency vulnerability PRs for npm and GitHub Actions. - **`.github/scripts/get-bot-token.mjs`** — generates a short-lived commitperclip installation token from `COMMITPERCLIP_KEY` secret. - **`.github/scripts/run-quality-gates.mjs`** — orchestrates 5 quality gates, posts/updates a single consolidated comment on the PR. - **`.github/scripts/check-pr-template.mjs`** — validates all 5 required template sections, Thinking Path depth (≥3 sentences), Model Used not placeholder. - **`.github/scripts/check-pr-linked-issue.mjs`** — requires `Fixes #NNN` or issue URL in PR body. - **`.github/scripts/check-pr-test-coverage.mjs`** — requires at least one test file in the diff. - **`.github/scripts/check-pr-lockfile.mjs`** — blocks manual `pnpm-lock.yaml` edits (only the refresh bot may change it). - **`.github/scripts/check-pr-dependencies.mjs`** — informational comment when new npm packages are added. - **`.github/scripts/check-pr-security.mjs`** — 6 silent security checks: secret patterns, CI workflow tampering, build script changes, supply chain (new packages in lockfile), suspicious test patterns (outbound network/shell exec/env var reads), and changes to the 9 sensitive path prefixes from the April advisories. When any fire: creates a draft security advisory + sets `security-review` check to `in_progress` (blocks merge). When clean: sets `security-review` to `success`. - **`actions/dependency-review-action@v4`** — per-PR dependency vulnerability check (fails if new dep has known CVE). - **44 unit tests** across all gate modules (`node:test`, no external deps). ## Verification Run all unit tests locally: ```bash node --test .github/scripts/tests/*.test.mjs ``` Expected: 44 pass, 0 fail. End-to-end: open a PR missing the template, linked issue, and test files → commitperclip posts a consolidated comment listing all failures. Open a PR with all gates satisfied → `✅ All checks passing` comment posted, all check runs green. ## Risks **`pull_request_target` security model:** This workflow runs in base branch context and has access to secrets. It explicitly checks out `ref: master` (never PR code) and reads the PR diff via GitHub API only — no PR code is ever executed. This is the correct pattern for running secret-bearing checks on fork PRs; deviating from it (e.g. checking out the PR branch) would be a security vulnerability. **False positives on security gates:** The sensitive-path gate flags any PR touching the 9 path prefixes from the April advisories. Legitimate fixes to those paths will trigger draft advisories. This is intentional — those paths warrant a human look regardless. The `security-review` check can be manually resolved by a maintainer once reviewed. **commitperclip not yet installed:** Until the app is installed on this repo and the `COMMITPERCLIP_KEY` secret is added, the workflow will fail on the token generation step. The quality gate comment won't post, but Dependency Review will still run independently. ## Model Used Claude Sonnet 4.5, 200k context window, extended thinking enabled, tool use: read/edit files, bash execution, GitHub API calls ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have run tests locally and they pass (44/44) - [x] I have added or updated tests where applicable (44 unit tests across all gate modules) - [ ] If this change affects the UI, I have included before/after screenshots (N/A — CI only) - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [x] I will address all Greptile and reviewer comments before requesting merge --- ## One-time setup needed from you, Dotta 1. **Install commitperclip app** on this repo: https://github.com/apps/commitperclip/installations/new 2. **Add `COMMITPERCLIP_KEY`** as a repository secret (Actions → Secrets) — ask @brandonburr for the key 3. **Add `security_advisories: write` and `checks: write`** to the commitperclip app permissions (commit-capital org → Settings → Apps → commitperclip → Permissions) 4. **Install Socket.dev** from GitHub Marketplace for supply chain scanning 5. **Branch protection** (optional but recommended): require `commitperclip-review` and `security-review` checks to pass before merge ## Dashboard integration note The `commitperclip-review` check run result maps cleanly to your PR triage dashboard. A single filter on your Worker: ```javascript const gatesCheck = checkRuns.find(r => r.name === 'commitperclip-review'); if (gatesCheck?.conclusion === 'failure') return null; // filter from queue ``` For security flags: `GET /repos/paperclipai/paperclip/security-advisories?state=draft` — advisory titles include `PR #NNN` for cross-referencing. PRs with a matching draft advisory have `security-review` in `in_progress` state (grey spinner, can't merge via branch protection). --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Devin Foley <devin@devinfoley.com> Co-authored-by: Paperclip <noreply@paperclip.ing>
89 lines
3.1 KiB
JavaScript
89 lines
3.1 KiB
JavaScript
#!/usr/bin/env node
|
|
/**
|
|
* check-pr-dependencies.mjs
|
|
* Detects new npm packages added in this PR vs. the base branch.
|
|
* Never fails (informational only) — outputs { passed: true, informational: string[] }
|
|
*/
|
|
import { fileURLToPath } from 'node:url';
|
|
import { ghFetch } from './get-bot-token.mjs';
|
|
|
|
function buildContentsPath(repo, filename, ref) {
|
|
return `/repos/${repo}/contents/${filename}?${new URLSearchParams({ ref }).toString()}`;
|
|
}
|
|
|
|
export async function resolveBaseRef(fetchFromGitHub, token, repo, prNumber, baseRef) {
|
|
if (baseRef) {
|
|
return baseRef;
|
|
}
|
|
|
|
const pr = await fetchFromGitHub(`/repos/${repo}/pulls/${prNumber}`, token);
|
|
if (pr.base?.ref) {
|
|
return pr.base.ref;
|
|
}
|
|
|
|
const repository = await fetchFromGitHub(`/repos/${repo}`, token);
|
|
if (repository.default_branch) {
|
|
return repository.default_branch;
|
|
}
|
|
|
|
throw new Error(`Unable to resolve a base branch for ${repo}#${prNumber}.`);
|
|
}
|
|
|
|
export async function checkDependencies(files, token, repo, prNumber, baseRef, fetchFromGitHub = ghFetch) {
|
|
const pkgFiles = files.filter(
|
|
f => f.filename.endsWith('package.json') &&
|
|
!f.filename.includes('node_modules') &&
|
|
f.status !== 'removed'
|
|
);
|
|
|
|
if (pkgFiles.length === 0) return { passed: true, informational: [] };
|
|
|
|
const resolvedBaseRef = await resolveBaseRef(fetchFromGitHub, token, repo, prNumber, baseRef);
|
|
const newPackages = new Set();
|
|
|
|
for (const file of pkgFiles) {
|
|
try {
|
|
const [baseRes, prRes] = await Promise.all([
|
|
fetchFromGitHub(buildContentsPath(repo, file.filename, resolvedBaseRef), token),
|
|
fetchFromGitHub(buildContentsPath(repo, file.filename, `refs/pull/${prNumber}/head`), token),
|
|
]);
|
|
|
|
const basePkg = JSON.parse(Buffer.from(baseRes.content, 'base64').toString());
|
|
const prPkg = JSON.parse(Buffer.from(prRes.content, 'base64').toString());
|
|
|
|
const baseDeps = new Set([
|
|
...Object.keys(basePkg.dependencies ?? {}),
|
|
...Object.keys(basePkg.devDependencies ?? {}),
|
|
...Object.keys(basePkg.peerDependencies ?? {}),
|
|
]);
|
|
|
|
for (const dep of [
|
|
...Object.keys(prPkg.dependencies ?? {}),
|
|
...Object.keys(prPkg.devDependencies ?? {}),
|
|
...Object.keys(prPkg.peerDependencies ?? {}),
|
|
]) {
|
|
if (!baseDeps.has(dep)) newPackages.add(dep);
|
|
}
|
|
} catch {
|
|
// File may not exist on base — skip
|
|
}
|
|
}
|
|
|
|
if (newPackages.size === 0) return { passed: true, informational: [] };
|
|
|
|
const pkgList = [...newPackages].map(p => `\`${p}\``).join(', ');
|
|
return {
|
|
passed: true,
|
|
informational: [
|
|
`📦 New dependencies added: ${pkgList}. Review may take longer and new dependencies ` +
|
|
`are less likely to be accepted — please check if existing deps cover this need.`,
|
|
],
|
|
};
|
|
}
|
|
|
|
if (process.argv[1] === fileURLToPath(import.meta.url)) {
|
|
const { GH_TOKEN, GH_REPO, PR_NUMBER, PR_FILES, PR_BASE_REF } = process.env;
|
|
const files = JSON.parse(PR_FILES ?? '[]');
|
|
const result = await checkDependencies(files, GH_TOKEN, GH_REPO, PR_NUMBER, PR_BASE_REF);
|
|
console.log(JSON.stringify(result));
|
|
}
|