Skip to content

fix(issue-triage): align @v0 docs/example with supported inputs #1154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(issue-triage): align @v0 docs/example with supported inputs #1154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 3 additions & 9 deletions docs/workflows/gh-agent-workflows/issue-triage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ mkdir -p .github/workflows && curl -fsSL \

| Input | Description | Default |
| --- | --- | --- |
| `additional-instructions` | Repo-specific instructions appended to the agent prompt. Use this to define label semantics for `classification-labels`. | `""` |
| `additional-instructions` | Repo-specific instructions appended to the agent prompt. | `""` |
| `setup-commands` | Shell commands run before the agent starts | `""` |
| `allowed-bot-users` | Allowlisted bot actor usernames (comma-separated) | `github-actions[bot]` |
| `classification-labels` | Comma-separated list of labels the agent may apply (e.g. `bug,needs-triage,enhancement`). If empty, no labels are applied. Define label semantics in `additional-instructions`. | `""` |

## Secrets

Expand All @@ -39,7 +38,6 @@ mkdir -p .github/workflows && curl -fsSL \
## Safe outputs

- `add-comment` — post a triage analysis comment on the issue
- `add-labels` — apply labels from the configured `classification-labels` allowlist (max 3); semantics defined via `additional-instructions`

## Example workflow

Expand All @@ -60,12 +58,8 @@ jobs:
run:
uses: elastic/ai-github-actions/.github/workflows/gh-aw-issue-triage.lock.yml@v0
# with:
# Configure which labels the agent may apply and define their semantics in additional-instructions.
# classification-labels: "bug,needs-triage,enhancement"
# additional-instructions: |
# - `bug`: Apply when the issue describes a clear defect or unexpected behavior.
# - `needs-triage`: Apply when more information is needed before the issue can be acted on.
# - `enhancement`: Apply when the issue describes a new feature or improvement request.
# setup-commands: |
# echo "Optional setup runs before triage begins"
secrets:
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
# Optional: pass an ephemeral token (e.g. a GitHub App token) so that issue labels
Expand Down
4 changes: 1 addition & 3 deletions gh-agent-workflows/issue-triage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ See [example.yml](example.yml) for the full workflow file.

| Input | Description | Required | Default |
| --- | --- | --- | --- |
| `additional-instructions` | Repo-specific instructions appended to the agent prompt. Use this to define label semantics for `classification-labels`. | No | `""` |
| `additional-instructions` | Repo-specific instructions appended to the agent prompt. | No | `""` |
| `setup-commands` | Shell commands run before the agent starts | No | `""` |
| `allowed-bot-users` | Allowed bot actor usernames (comma-separated) | No | `github-actions[bot]` |
| `classification-labels` | Comma-separated list of labels the agent may apply (e.g. `bug,needs-triage,enhancement`). If empty, no labels are applied. Define label semantics in `additional-instructions`. | No | `""` |

## Secrets

Expand All @@ -41,4 +40,3 @@ See [example.yml](example.yml) for the full workflow file.
## Safe Outputs

- `add-comment` — post a triage analysis comment on the issue
- `add-labels` — apply labels from the configured `classification-labels` allowlist (max 3); semantics defined via `additional-instructions`
8 changes: 2 additions & 6 deletions gh-agent-workflows/issue-triage/example.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,8 @@ jobs:
run:
uses: elastic/ai-github-actions/.github/workflows/gh-aw-issue-triage.lock.yml@v0
# with:
# Configure which labels the agent may apply and define their semantics in additional-instructions.
# classification-labels: "bug,needs-triage,enhancement"
# additional-instructions: |
# - `bug`: Apply when the issue describes a clear defect or unexpected behavior.
# - `needs-triage`: Apply when more information is needed before the issue can be acted on.
# - `enhancement`: Apply when the issue describes a new feature or improvement request.
# setup-commands: |
# echo "Optional setup runs before triage begins"
secrets:
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
# Optional: pass an ephemeral token (e.g. a GitHub App token) so that issue labels
Expand Down