jb/paseo
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(hub): document semantic GitHub triggers (#3643)

Browse Source
This commit is contained in:
Mohamed Boudra
2026-08-21 14:59:04 +02:00
committed by GitHub
parent c527b203c4
commit 97bdbebd7f
4 changed files with 233 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
public-docs/hub/configuration/hub-yml.md
+33
View File
@@ -137,6 +137,39 @@ steps:
| `values` | no | Named expressions. |
| `steps` | yes | One or more ordered inline steps. |
### GitHub events and filters
Use one of these semantic event names for new GitHub workflows:
| `on` | Matches |
| ------------------------------------- | ------------------------------------------------------------------------- |
| `github.issue_created` | An `issues` delivery whose action is `opened`. |
| `github.pull_request_created` | A `pull_request` delivery whose action is `opened`. |
| `github.issue_comment_created` | An `issue_comment` delivery whose action is `created`, on an issue. |
| `github.pull_request_comment_created` | An `issue_comment` delivery whose action is `created`, on a pull request. |
| `github.issue_label_added` | An `issues` delivery whose action is `labeled`. |
| `github.pull_request_label_added` | A `pull_request` delivery whose action is `labeled`. |
Existing configurations may continue to use `github.issues`, `github.issue_comment`, `github.pull_request_review`, `github.pull_request_review_comment`, and `github.push`. These legacy events retain their existing behavior.
`filters` supports these GitHub fields. `from_users` must be non-empty for every externally sourced workflow. All supplied filters compose with AND.
| Field | Type | Applies to | Meaning |
| ------------ | ----------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `from_users` | non-empty list of strings | all GitHub events | GitHub logins allowed to start the workflow. |
| `repo` | non-empty string | all GitHub events | Repository in `owner/name` form. |
| `connection` | string | all GitHub events | GitHub connection slug. |
| `contains` | string | issue, pull-request, and comment events | Substring in the issue or pull-request title plus body, or in the comment body. |
| `pattern` | string | issue, pull-request, and comment events | Start of that same text. |
| `label` | non-empty string | `github.issue_label_added`, `github.pull_request_label_added` | The label added by the delivery. |
| `labels` | non-empty list of non-empty strings | issue, pull-request, and comment events | Every listed label must be currently present on the issue or pull request. |
`label` and `labels` match GitHub labels case-insensitively. `label` checks the one changed label; `labels` checks the full current label set and requires every entry. For example, `labels: [bug, backend]` requires both `bug` and `backend`.
Use `label` only with a label-added event. It has no match on other events. Use `labels` to require the item state, including when a comment starts the workflow.
See [GitHub triggers](/docs/hub/triggers/github) for complete triage, pull-request review, and ready-for-agent workflows.
### Inputs and values
Inputs have `type: string | number | boolean`, plus optional `required`, `default`, and `choices`. `required` and `default` cannot be combined. Finite `choices` are required when an input can choose authority such as an environment or named agent.