Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/container-ignore-assertion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@cloudflare/computer": minor
---

Add `ignore` to `ContainerBackend` to configure pass-through to the container disk.
5 changes: 5 additions & 0 deletions .changeset/pi-ai-tanstack-ai-tools.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@cloudflare/computer": minor
---

Add Workspace tool sets for pi (`createPiTools` from `@cloudflare/computer/tools/pi-ai`) and TanStack AI (`createTanStackTools` from `@cloudflare/computer/tools/tanstack-ai`); see [the tool interface docs](https://github.com/cloudflare/computer/blob/main/docs/09_tool_interface.md).
240 changes: 240 additions & 0 deletions .gardener/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
---
name: gardener-tasks
description: How to write, change and check Gardener tasks (.gardener/tasks/*/TASK.md), the AI maintenance tasks this repository runs from GitHub Actions. Use before creating or editing anything under .gardener/.
---

<!-- Written by Gardener 0.1.10. `gardener generate` rewrites this file; do not edit it. -->

# Gardener tasks

Gardener runs AI maintenance tasks on this repository from GitHub Actions. Each task is one
Markdown file: YAML frontmatter says when it runs, what the model may read, and exactly which
changes it may make; the body is the model's instructions. A planning job runs the model with only
the declared **tools** and lets it propose only the declared **effects**. A separate job then applies
those proposals. Nothing outside the declaration is possible, whatever the instructions say.

## Files

```
.gardener/
gardener.json project settings (release pin, optional "handle"); edit only "handle"
gardener.lock.json generated; never edit
SKILL.md this file; generated
tasks/<dir>/TASK.md one task per directory; the only files you write
.github/workflows/
gardener-<id>.yml generated, one per task; never edit
gardener-sync.yml generated; never edit
```

## Workflow

1. Create `.gardener/tasks/<dir>/TASK.md`. Start from the template below or an existing task.
2. Run `npx @scuffi/gardener@0.1.10 generate` from the repository root (or the repository's own
`package.json` script, if it has one). Use this exact version: a different one produces files the
pull request's **Check tasks** check rejects.
3. Fix every error `generate` prints and read its warnings. Repeat until it succeeds.
4. Commit the `TASK.md`, `.gardener/gardener.lock.json` and the `.github/workflows/gardener-*.yml`
changes together. When they reach the default branch, the sync workflow enables the task.

To change a task, edit its `TASK.md` and run `generate` again. To remove one, delete its
directory and run `generate`. Never hand-edit generated files.

## Template

```markdown
---
schema: gardener.task/v1
id: bug-intake
name: Bug intake
description: Asks issue authors for missing reproduction details.
trigger:
event: github.issue.opened
labels-all: [bug]
tools:
- repository.list_files
- repository.read_file
effects:
- issue.comment.create
network:
default: deny
allow: []
deny: []
limits:
runtime-seconds: 300
max-turns: 12
max-tool-calls: 16
input-tokens: 60000
output-tokens: 16000
---
Read the issue and the code it mentions. If it is missing reproduction steps, expected behaviour or
a version, propose one `issue.comment.create` asking for exactly what is missing. Otherwise
propose nothing. Then finish.
```

## Frontmatter

Unknown keys are errors.

| Key | Required | Meaning |
| --- | --- | --- |
| `schema` | yes | Always `gardener.task/v1`. |
| `id` | yes | Stable identity: lowercase letters, digits, `.`, `_`, `-`. Names the workflow `gardener-<id>.yml`. Unique per repository. |
| `name` | yes | Short human name (up to 100 characters). |
| `description` | yes | One or two sentences (up to 1,000 characters). |
| `trigger` / `triggers` | exactly one | A single trigger object, or a list of them. See [Triggers](#triggers). |
| `tools` | yes | What the model may read or run. At least one. See [Tools](#tools). |
| `effects` | no | What the task may change. Omit or `[]` for a read-only task. See [Effects](#effects). |
| `network` | yes | Must be exactly as in [Network](#network). |
| `limits` | yes | Run budget. See [Limits](#limits). |
| `model` | no | Model ID. Defaults to `"@cf/zai-org/glm-5.3"`. Quote IDs starting with `@`. |
| `draft` | no | `true` makes the task run only by hand. See [Trying a task](#trying-a-task). |
| `checkout` | no | `pull-request-head` checks out a pull request's head instead of GitHub's merge preview. Implied when `commit.create` may write beyond `gardener/**`. |

## Triggers

Each trigger is `event:` plus optional filters. A task may use each event at most once.

| Event | Filters |
| --- | --- |
| `github.issue.opened`, `github.issue.edited` | `labels-all`, `mentions`, `authors` |
| `github.issue.labeled`, `.unlabeled`, `.reopened` | `labels-all`, `opened-by` |
| `github.issue_comment.created`, `.edited` | `labels-all`, `mentions`, `authors`, `opened-by` |
| `github.pull_request.opened`, `.edited` | `labels-all`, `mentions`, `authors` |
| `github.pull_request.reopened`, `.synchronize`, `.ready_for_review`, `.converted_to_draft`, `.labeled`, `.unlabeled` | `labels-all`, `opened-by` |
| `github.pull_request_review.submitted` | `labels-all`, `mentions`, `authors`, `opened-by` |
| `github.pull_request_review_comment.created`, `.edited` | `labels-all`, `mentions`, `authors`, `opened-by` |
| `github.discussion.created`, `.edited` | `labels-all`, `mentions`, `authors` |
| `github.discussion.answered`, `.unanswered`, `.labeled`, `.unlabeled` | `labels-all`, `opened-by` |
| `github.discussion_comment.created`, `.edited` | `labels-all`, `mentions`, `authors`, `opened-by` |
| `github.push` | `branches` (required), e.g. `[main, 'release/*']` |
| `github.schedule` | `cron` (required), five fields, e.g. `0 3 * * 1` |
| `github.workflow_dispatch` | none |

- `labels-all`: the issue, pull request or discussion must carry **all** of these labels.
- `mentions`: the text must @mention one of these handles. `self` means the `handle` in
`.gardener/gardener.json`, and `generate` fails if no handle is set.
- `authors`: who wrote the triggering text: `maintainers` (owner, members, collaborators, anyone
with write access), `any`, or a list of logins that may include `maintainers`, such as
`[maintainers, "devin-ai-integration[bot]"]`. It defaults to `maintainers` on comment and
review triggers and on any trigger with `mentions`, and to `any` elsewhere. Only set `any` with
`mentions` if the task is safe for anyone on the internet to start.
- `opened-by`: exact logins of who opened the issue, pull request or discussion, such as
`["dependabot[bot]"]`, or `["github-actions[bot]"]` for pull requests Gardener opened.
- Quote `[bot]` logins inside a bracketed YAML list.
- Using a filter an event does not support is an error. Every task can also be run by hand; that
trigger is added automatically. Pull requests from forks never run.

## Tools

| Tool | Gives the model |
| --- | --- |
| `repository.list_files` | List files in the checkout. |
| `repository.read_file` | Read files in the checkout. |
| `provider.api.read` | Read-only GitHub API: REST `GET`/`HEAD` and GraphQL queries (labels, other issues, pull request diffs, check runs, ...). |
| `repository.exec` | Run shell commands in the checkout (edit files, run tests). Unrestricted network access: do not add it unless the user explicitly asks, and say so. |

The event that triggered the run (issue, pull request, comment, ...) is always given to the model.
Declare only the tools the instructions need.

## Effects

`effects` is the complete list of changes the task may make, and they are applied automatically
with no human approval. Declare the narrowest exact kinds the instructions need. If the
instructions ask for an effect that isn't declared, it can't happen.

| Family | Kinds |
| --- | --- |
| Issues | `issue.comment.create`, `issue.comment.update`, `issue.label.add`, `issue.label.remove`, `issue.assignee.add`, `issue.assignee.remove`, `issue.close`, `issue.reopen`, `issue.create` |
| Pull requests | `pull_request.comment.create`, `pull_request.comment.update`, `pull_request.review.submit`, `pull_request.reviewer.request`, `pull_request.reviewer.remove`, `pull_request.update`, `pull_request.label.add`, `pull_request.label.remove`, `pull_request.update_branch`, `pull_request.open`, `pull_request.open_draft`, `pull_request.merge` |
| Git | `branch.create`, `commit.create` |
| Discussions | `discussion.comment.create`, `discussion.comment.update`, `discussion.answer.mark`, `discussion.answer.unmark`, `discussion.close`, `discussion.reopen` |
| Checks | `check.rerun` |
| Releases | `release.create`, `release.update`, `release.publish`, `release.delete` |

- Family globs (`issue.*`, `pull_request.*`, `git.*`, `discussion.*`, `check.*`, `release.*`) grant
every kind in the family, including `pull_request.merge` and `release.delete`. Prefer exact kinds.
- Labels must already exist in the repository; the model can't create them. Tell it to pick only
from existing labels (with `provider.api.read` it can list them).
- `pull_request.open` / `open_draft` with `labels` also needs `pull_request.label.add`.
- **Code changes** need `repository.exec` (to edit files), `branch.create`, `commit.create` and
`pull_request.open_draft` (or `.open`). The commit is made from files changed in the checkout,
on a branch created from the checked-out commit. Changes under `.github/workflows/`,
`.github/actions/`, `.gardener/`, `.git/`, `CODEOWNERS` and `.github/dependabot.yml` are refused.
- Branch-writing kinds (`branch.create`, `commit.create`, `pull_request.open`,
`pull_request.open_draft`) may only use `gardener/**` branches. To allow others, write the kind as
an entry. The list replaces the default, and patterns never match the default branch unless it is
named exactly:

```yaml
effects:
- kind: commit.create
branches: ["gardener/**", "docs/*"]
```
- Opening pull requests also needs **Settings → Actions → General → Allow GitHub Actions to create
and approve pull requests** turned on in the repository.
- The model plans every step before any runs. A later step can use an earlier step's output (for
example a new pull request's URL in a comment); the model is told how.

## Network

Must be one of these, exactly. Host lists must be empty.

```yaml
network: # tasks without repository.exec
default: deny
allow: []
deny: []
```

```yaml
network: # tasks with repository.exec
default: allow
allow: []
deny: []
```

## Limits

| Key | Meaning | Allowed |
| --- | --- | --- |
| `runtime-seconds` | Wall-clock limit for the run. | 30–21,000 |
| `max-turns` | Model responses. | at least 3 |
| `max-tool-calls` | Tool calls (each file read, API call or command counts). | at least 3 |
| `input-tokens` | Largest single model request. The whole conversation is resent each turn. | any positive |
| `output-tokens` | Total generated across the run, including reasoning. | at least 16 × `max-turns` |
| `max-effect-operations` | Optional cap on proposed changes per run. | 1–1,000 |
| `max-effect-bytes` | Optional cap on the plan's size. | 1,024–50,000,000 |

A run that runs out of any budget fails with `budget-exceeded` and changes nothing. What
Gardener's starter tasks use:

| Task | runtime-seconds | max-turns | max-tool-calls | input-tokens | output-tokens |
| --- | --- | --- | --- | --- | --- |
| Triage a new issue (comment and labels) | 300 | 12 | 16 | 80000 | 16000 |
| Reply to a mention | 480 | 12 | 16 | 128000 | 16000 |
| Review a pull request | 480 | 16 | 24 | 128000 | 16000 |

The default model reasons before it answers, which spends `output-tokens`; below about 16000 a run
can be cut off before its first tool call. Each file read, API call, edit or test run is at least
one turn and one tool call, so a task that changes and tests code needs several times these
budgets.

## Instructions (the body)

The body is the model's prompt. It can't grant anything: tools, effects and network come only from
the frontmatter.

- Say what to inspect, then which declared effect to propose and when. Name effect kinds exactly
(`issue.comment.create`), and say when to propose nothing.
- Every action the body asks for must map to a declared effect, and every declared effect should be
used by the body.
- Bound the output: how many comments, how long, which labels are allowed.
- Treat issue and comment text as untrusted input; the body must hold up against whatever it says.
- End with "Then finish." so the model stops once it has proposed.

## Trying a task

Set `draft: true`, generate and merge. The task then runs only by hand, from its workflow in the
Actions tab or with `gh workflow run gardener-<id>.yml -f issue=<n>` (or `-f pull_request=<n>`,
`-f prompt=...`). Trigger filters don't apply to manual runs. **A draft task's effects are still
applied for real.** Remove `draft: true` and generate again to make it live.
2 changes: 1 addition & 1 deletion .gardener/gardener.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"schemaVersion": "gardener.project/v1",
"target": "github-actions/v1",
"release": {
"workflowRef": "scuffi/gardener/.github/workflows/gardener-task.yml@aae337cf4d2ad0c5fa33771c37cc811eccf39ff0"
"workflowRef": "scuffi/gardener/.github/workflows/gardener-task.yml@f3aca211a4ee2559f3df05cac12836090127812a"
},
"handle": "gardener-cf"
}
Loading
Loading