baa92f37e0
This is a first cut at a GitHub Action that lets you define prompt
templates in `.md` files under `.github/codex/labels` that will run
Codex with the associated prompt when the label is added to a GitHub
pull request.
For example, this PR includes these files:
```
.github/codex/labels/codex-attempt.md
.github/codex/labels/codex-code-review.md
.github/codex/labels/codex-investigate-issue.md
```
And the new `.github/workflows/codex.yml` workflow declares the
following triggers:
```yaml
on:
issues:
types: [opened, labeled]
pull_request:
branches: [main]
types: [labeled]
```
as well as the following expression to gate the action:
```
jobs:
codex:
if: |
(github.event_name == 'issues' && (
(github.event.action == 'labeled' && (github.event.label.name == 'codex-attempt' || github.event.label.name == 'codex-investigate-issue'))
)) ||
(github.event_name == 'pull_request' && github.event.action == 'labeled' && github.event.label.name == 'codex-code-review')
```
Note the "actor" who added the label must have write access to the repo
for the action to take effect.
After adding a label, the action will "ack" the request by replacing the
original label (e.g., `codex-review`) with an `-in-progress` suffix
(e.g., `codex-review-in-progress`). When it is finished, it will swap
the `-in-progress` label with a `-completed` one (e.g.,
`codex-review-completed`).
Users of the action are responsible for providing an `OPENAI_API_KEY`
and making it available as a secret to the action.
34 lines
1.1 KiB
TypeScript
34 lines
1.1 KiB
TypeScript
// Validate the inputs passed to the composite action.
|
|
// The script currently ensures that the provided configuration file exists and
|
|
// matches the expected schema.
|
|
|
|
import type { Config } from "./config";
|
|
|
|
import { existsSync } from "fs";
|
|
import * as path from "path";
|
|
import { fail } from "./fail";
|
|
|
|
export function performAdditionalValidation(config: Config, workspace: string) {
|
|
// Additional validation: ensure referenced prompt files exist and are Markdown.
|
|
for (const [label, details] of Object.entries(config.labels)) {
|
|
// Determine which prompt key is present (the schema guarantees exactly one).
|
|
const promptPathStr =
|
|
(details as any).prompt ?? (details as any).promptPath;
|
|
|
|
if (promptPathStr) {
|
|
const promptPath = path.isAbsolute(promptPathStr)
|
|
? promptPathStr
|
|
: path.join(workspace, promptPathStr);
|
|
|
|
if (!existsSync(promptPath)) {
|
|
fail(`Prompt file for label '${label}' not found: ${promptPath}`);
|
|
}
|
|
if (!promptPath.endsWith(".md")) {
|
|
fail(
|
|
`Prompt file for label '${label}' must be a .md file (got ${promptPathStr}).`,
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|