Merged
Conversation
Add comprehensive documentation for all natural-language trigger shorthands supported by ParseTriggerShorthand, including: - Source control: push to/tags, pull_request types/merged/affecting - Issue and discussion activity type shorthands - Manual, comment, release, repository shorthands - Security (dependabot, code scanning) shorthands - External integration (api dispatch) shorthands - Complete reference table with expansion details The label trigger shorthands were already documented; all other trigger shorthands were previously undocumented. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Consolidate 8 subsections into 3, remove redundant reference table, and cross-reference the existing Label Filtering section instead of duplicating label shorthand docs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing documentation for the natural-language trigger shorthand strings accepted by the on: field and expanded by the compiler into GitHub Actions trigger syntax.
Changes:
- Added a new Trigger Shorthands reference section for
on:string forms (e.g.,push to main,pull_request merged,issue opened, etc.). - Documented supported shorthand categories (source control, issues/discussions, manual/workflow chaining, comments, releases, repository lifecycle, security, external integration).
- Linked to the existing Label Filtering section to avoid duplicating label-shorthand docs.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add documentation for all natural-language trigger shorthands supported by
ParseTriggerShorthand. A user in our Slack channel asked about one of these, and pointed out that they are not documented.The
on:field accepts shorthand strings likepush to main,pull_request merged,issue opened,release published, etc. that the compiler expands into standard GitHub Actions trigger syntax. These were previously undocumented (only label shorthands likeissue labeled bugwere documented).Changes:
docs/src/content/docs/reference/triggers.md