@@ -9,7 +9,7 @@ Consumer repositories reference this repo for **composite actions**, **reusable
99workflows** , and ** standalone scripts** , so review logic, prompts, and policy
1010live in one place and roll out to every repo by bumping a tag.
1111
12- Replace ` your-org ` throughout with the GitHub organization this repo lives in.
12+ Replace ` filecoin-project ` throughout with the GitHub organization this repo lives in.
1313
1414## Repository layout
1515
@@ -22,7 +22,8 @@ ff-sec-action/
2222│ ├── review.sh
2323│ └── schema.json
2424├── .github/workflows/ # Reusable workflows (whole job, workflow_call)
25- │ └── ai-code-review.yml
25+ │ ├── ai-code-review.yml
26+ │ └── manual-ai-code-review.yml # workflow_dispatch test harness (runs the local action)
2627├── scripts/ # Standalone scripts runnable outside any action
2728├── prompts/ # Domain knowledge as data, not code
2829│ ├── base-reviewer.md # Always included: review behavior + output rules
@@ -58,7 +59,7 @@ concurrency:
5859jobs :
5960 review :
6061 if : ${{ !github.event.pull_request.draft }}
61- uses : your-org /ff-sec-action /.github/workflows/ai-code-review.yml@v1
62+ uses : filecoin-project /ff-sec-actions /.github/workflows/ai-code-review.yml@v1
6263 with :
6364 domain : filecoin # picks prompts/filecoin.md
6465 fail-on-severity : none # or: critical | high | medium
8687 contents: read
8788 pull-requests: write # needed to post the review comment
8889 steps:
89- - uses: your-org /ff-sec-action /actions/ai-code-review@v1
90+ - uses: filecoin-project /ff-sec-actions /actions/ai-code-review@v1
9091 id: ai
9192 with:
9293 anthropic-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
@@ -112,7 +113,7 @@ Two patterns:
112113steps:
113114 - uses: actions/checkout@v4
114115 with:
115- repository: your-org /ff-sec-action
116+ repository: filecoin-project /ff-sec-actions
116117 ref: v1 # or a full SHA for the strictest pinning
117118 path: .ff-sec
118119 - run: bash .ff-sec/scripts/<script>.sh
@@ -123,7 +124,7 @@ steps:
123124**b. Locally, from a clone:**
124125
125126` ` ` sh
126- git clone --depth 1 --branch v1 https://github.com/your-org /ff-sec-action
127+ git clone --depth 1 --branch v1 https://github.com/filecoin-project /ff-sec-actions
127128bash ff-sec-action/scripts/<script>.sh
128129` ` `
129130
@@ -132,7 +133,7 @@ and fails fast with a clear message when one is missing. Example — running the
132133AI review against any PR from your terminal :
133134
134135` ` ` sh
135- PR_NUMBER=123 REPO=your-org /some-repo \
136+ PR_NUMBER=123 REPO=filecoin-project /some-repo \
136137ANTHROPIC_API_KEY=... GH_TOKEN=$(gh auth token) \
137138PROMPT_FILE=prompts/filecoin.md BASE_PROMPT_FILE=prompts/base-reviewer.md \
138139SCHEMA_FILE=actions/ai-code-review/scripts/schema.json \
@@ -165,6 +166,8 @@ executes PR code**.
165166|---|---|---|
166167| `anthropic-api-key` | — (required) | Pass from secrets |
167168| `github-token` | `${{ github.token }}` | Needs `pull-requests : write` to comment |
169+ | `pr-number` | current PR event | Set explicitly for `workflow_dispatch` runs |
170+ | `repo` | current repository | Cross-repo runs need a `github-token` with access to that repo |
168171| `model` | `claude-opus-4-8` | Any current Claude model ID |
169172| `domain` | `filecoin` | Resolves `prompts/<domain>.md` |
170173| `prompt-file` | `""` | Absolute path override; beats `domain` |
@@ -253,7 +256,7 @@ Guidelines:
253256 this repo : it owns `runs-on`, `permissions` (least privilege), and secret
254257 plumbing — the action owns the logic. That keeps both surfaces in sync.
255258- Reference the sibling action by **full path with a tag**
256- (`uses : your-org /ff-sec-action /actions/<name>@v1`), not a relative path —
259+ (`uses : filecoin-project /ff-sec-actions /actions/<name>@v1`), not a relative path —
257260 relative references don't resolve without a checkout. Keep the tag in sync
258261 when releasing (grep for `@v1` before tagging).
259262- Mirror the composite action's inputs 1:1 with the same names and defaults so
@@ -309,8 +312,15 @@ Guidelines:
309312- **Local dry-run:** every script must be runnable locally with env vars (see
310313 [Standalone scripts](#3-standalone-scripts)) — use a real PR in a sandbox
311314 repo and `POST_COMMENT=false`-style flags.
312- - **End-to-end:** open a PR against a sandbox repo whose workflow points at
313- your branch : ` uses: your-org/ff-sec-action/actions/<name>@<your-branch>` .
315+ - **Manual run (fastest end-to-end):** Actions tab → "AI Code Review (manual)"
316+ → Run workflow. Pick your branch, give it a PR number (any PR in this repo,
317+ or another repo via the `repo` input + a `GH_PAT` secret). It checks out the
318+ selected branch and runs the **local** action, so branch changes are tested
319+ before any tag exists. `post-comment` defaults to `false` — results land in
320+ the job summary.
321+ - **End-to-end from a consumer:** open a PR against a sandbox repo whose
322+ workflow points at your branch :
323+ `uses : filecoin-project/ff-sec-actions/actions/<name>@<your-branch>`.
314324 Verify the comment, job summary, outputs, and the failure gate.
315325- PRs to this repo get reviewed by the org security team (add a `CODEOWNERS`
316326 entry for your action's directory if you want ownership).
0 commit comments