Skip to content

Document pull_request state transitions in schema #6316

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

Merged
pelikhan merged 3 commits into from
Dec 13, 2025
Merged

Document pull_request state transitions in schema #6316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d315c8b
Initial plan
Copilot Dec 13, 2025
fd66547
Add documentation for draft/ready_for_review state transitions
Copilot Dec 13, 2025
8771d50
Completed documentation changes with all validations passed
Copilot Dec 13, 2025
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: 4 additions & 1 deletion docs/src/content/docs/reference/frontmatter-full.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,10 @@ on:
# created, updated, or closed
# (optional)
pull_request:
# List of pull request event types to trigger on
# Pull request event types to trigger on. Note: 'converted_to_draft' and
# 'ready_for_review' represent state transitions (events) rather than states.
# While technically valid to listen for both, consider if you need to handle both
# transitions or just one.
# (optional)
types: []
# Array of strings
Expand Down
3 changes: 2 additions & 1 deletion pkg/parser/schemas/main_workflow_schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,8 @@
"properties": {
"types": {
"type": "array",
"description": "List of pull request event types to trigger on",
"description": "Pull request event types to trigger on. Note: 'converted_to_draft' and 'ready_for_review' represent state transitions (events) rather than states. While technically valid to listen for both, consider if you need to handle both transitions or just one.",
"$comment": "converted_to_draft and ready_for_review are logically opposite state transitions. Using both may indicate unclear intent.",
"items": {
"type": "string",
"enum": [
Expand Down