Mohamed BoudraandGitHub
dfd18a44a7
* feat(website): nest docs pages under landable groups The docs sidebar could already render groups from subdirectories in public-docs, but nothing used it because every doc was a flat file, and two things stopped it being usable. A group had no page of its own, so its label was only a toggle and its name came from the directory name via formatLabel. A directory's index.md now supplies the group's label, order, and href, which makes the group landable and lets the label be authored rather than derived. Categories and top-level directories named the same thing, so a categorised doc at hub/index.md produced a group nested inside its own category. Only directories below the top level become groups now. Also fixes two behaviours in the sidebar: - The open/closed effect assigned containsActive on every change, so a group you expanded to browse collapsed the moment you navigated anywhere else. Navigating in now opens a group and navigating away leaves it alone. - The sidebar scrolls independently of the page and never scrolled the active entry into view, so loading or refreshing a page far down the list left the sidebar parked at the top with no visible position. The group row is a single target: it navigates and expands, and collapses when clicked again from the page it points at. A separate chevron button would put two actions a few pixels apart. * docs(hub): document Hub Adds a Hub section covering what it is, how it works, daemons, triggers, configuration, activity, and the two ways to run it. The section separates using Hub from running it. Overview, quickstart, daemons, triggers, and configuration hold regardless of who operates the deployment; the self-hosting branch owns deploying the service and creating the GitHub, Slack, and Discord apps it talks to. That split falls on a real seam, because those apps are exactly what a hosted Hub would own on your behalf. Hosted is a placeholder until it ships. Each provider gets a trigger page carrying its events, filter semantics, and the full paseo.event.* reference for the data a prompt can read. That data is the thing a config author actually needs and the thing they cannot get from anywhere else. Every YAML block was parsed against the Hub config schema rather than eyeballed, which kept several plausible-looking things out of the docs: worktree prNumber takes a literal number and not a merge variable, only daemon environments run today, and github.push has no actor so it can never satisfy the required from_users filter. Troubleshooting moves to order 90 so it stays last. * refactor(website): let the active docs entry scroll itself into view The layout queried the sidebar for the active entry after every navigation, which coupled it to when that entry mounts. A link inside a collapsed group only mounts once the group's own effect opens it, so the query could run against a DOM that does not contain it yet. Moving the scroll to the entry removes the ordering question rather than answering it, and drops the ref and the cross-component query. Reported by Greptile on #2864. The failure it described does not reproduce: navigating from a page outside a collapsed group into one of its children still scrolls correctly, verified with the group confirmed collapsed and the sidebar forced to the top. The coupling was real even though the bug was not. * docs(hub): stop listing BETTER_AUTH_URL as required It falls back to PASEO_CLOUD_PUBLIC_URL, so a deployment that sets the public origin already has a correct auth base URL. Listing it as required made the Fly recipe look incomplete when it was not. Moved to optional with its default, and recorded what actually breaks without BETTER_AUTH_SECRET: the auth routes close and nobody can sign in. Reported by Codex on #2864, which read the same inconsistency the other way round and proposed adding the variable to the Fly example. * docs(hub): attach a database in the Fly recipe The Fly section showed inline config and a secrets command, neither of which supplied DATABASE_URL. It defaults to localhost:5432, which on Fly reaches nothing, so the documented deployment could not start. fly postgres attach sets DATABASE_URL as a secret, so the step is the attach itself rather than another variable to copy. Reported by Codex on #2864. * docs: align Hub self-hosting contract
114 lines
4.4 KiB
Markdown
114 lines
4.4 KiB
Markdown
---
|
|
title: GitHub triggers
|
|
description: GitHub events Hub can trigger on, how filters match them, and the full paseo.event.github data reference.
|
|
nav: GitHub
|
|
order: 65
|
|
category: Hub
|
|
---
|
|
|
|
# GitHub triggers
|
|
|
|
## Events
|
|
|
|
| `on` | Fires when |
|
|
| ------------------------------------ | ------------------------------------- |
|
|
| `github.issue_comment` | A comment on an issue or pull request |
|
|
| `github.issues` | An issue is opened or edited |
|
|
| `github.pull_request_review` | A review is submitted |
|
|
| `github.pull_request_review_comment` | A comment on a diff |
|
|
|
|
Which repositories produce events is set on the GitHub connection's installation, not in Paseo.
|
|
|
|
## Filters
|
|
|
|
```yaml
|
|
filters:
|
|
repo: acme/api
|
|
contains: "@paseo"
|
|
from_users: [alice, bob]
|
|
```
|
|
|
|
- `from_users` matches the GitHub **login** of the event's sender.
|
|
- `repo` is `owner/name`, resolved to the repository's immutable id on activation.
|
|
- `contains` is a substring test; `pattern` must match at the start.
|
|
|
|
The text those two search depends on the event:
|
|
|
|
| Event | Text searched |
|
|
| ------------------------------------ | -------------------- |
|
|
| `github.issue_comment` | The comment body |
|
|
| `github.issues` | Issue title and body |
|
|
| `github.pull_request_review` | The review body |
|
|
| `github.pull_request_review_comment` | The comment body |
|
|
|
|
## Tokens
|
|
|
|
A GitHub-triggered execution automatically receives a `GH_TOKEN` scoped to the triggering repository, with `contents`, `issues`, and `pull_requests` write access. It is minted per execution and revoked when the execution ends. You do not map it in `env`.
|
|
|
|
For a token from a _different_ connection, or from a non-GitHub trigger, name it explicitly:
|
|
|
|
```yaml
|
|
env:
|
|
GH_TOKEN: ${{ paseo.connections.acme-github.token }}
|
|
```
|
|
|
|
## Data reference
|
|
|
|
GitHub's webhook payload is available directly under `paseo.event.github`, unflattened. Anything GitHub sends, you can read:
|
|
|
|
```yaml
|
|
prompt: |
|
|
${{ paseo.event.github.issue.title }}
|
|
by ${{ paseo.event.github.sender.login }}
|
|
on ${{ paseo.event.github.repository.full_name }}
|
|
```
|
|
|
|
Common paths by event:
|
|
|
|
| Event | Useful paths |
|
|
| ------------------------------------ | ------------------------------------------------------------------------------- |
|
|
| `github.issue_comment` | `comment.body`, `comment.html_url`, `issue.number`, `issue.title`, `issue.body` |
|
|
| `github.issues` | `issue.number`, `issue.title`, `issue.body`, `action` |
|
|
| `github.pull_request_review` | `review.body`, `review.state`, `pull_request.number` |
|
|
| `github.pull_request_review_comment` | `comment.body`, `comment.path`, `comment.diff_hunk`, `pull_request.number` |
|
|
|
|
All events also carry `sender.login`, `repository.full_name`, and `repository.default_branch`.
|
|
|
|
Hub adds an envelope alongside GitHub's fields:
|
|
|
|
| Path | Value |
|
|
| ---------------------- | ---------------------------------------------- |
|
|
| `delivery_id` | GitHub's webhook delivery id |
|
|
| `event_name` | `issue_comment`, `issues`, … |
|
|
| `repository_full_name` | `owner/name` |
|
|
| `installation_id` | The installation that delivered the event |
|
|
| `received_at` | When Hub accepted it |
|
|
| `trigger_url` | Canonical URL of the comment, issue, or review |
|
|
|
|
`trigger_url` is only present when the event has one. It is the field you usually want in a prompt.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
triggers:
|
|
- name: review-fix
|
|
on: github.pull_request_review_comment
|
|
environment: dev
|
|
filters:
|
|
repo: acme/api
|
|
contains: "@paseo"
|
|
from_users: [alice]
|
|
agent:
|
|
provider: codex
|
|
mode: full-access
|
|
prompt: |
|
|
${{ paseo.event.github.sender.login }} left this on PR
|
|
#${{ paseo.event.github.pull_request.number }},
|
|
in ${{ paseo.event.github.comment.path }}:
|
|
|
|
${{ paseo.event.github.comment.body }}
|
|
|
|
Fix it and push. Reply on the thread with gh when you're done.
|
|
${{ paseo.event.github.trigger_url }}
|
|
```
|