Skip to content

Commit fea69c8

Browse files
justin808claude
andcommitted
Document manual workflow triggering in GitHub Actions
Add comprehensive documentation for manually triggering workflows via GitHub UI and CLI. Explains the important limitation that the "Run workflow" button only appears for workflows merged to master, and provides CLI alternatives for testing workflows before merge. Includes: - Step-by-step UI instructions - GitHub CLI command examples - List of workflows supporting manual triggers - Explanation of force_run parameter - Use cases for manual triggering 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent 1969b2d commit fea69c8

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/read-me.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,62 @@ Most workflows use minimal permissions. The comment-triggered workflows require:
105105
- `pull-requests: write` - To post comments and reactions
106106
- `actions: write` - To trigger other workflows
107107

108+
## Manually Triggering Workflows
109+
110+
Many workflows support manual triggering via `workflow_dispatch`, which allows you to run them on-demand from any branch.
111+
112+
### Using the GitHub UI
113+
114+
**Important**: The "Run workflow" button only appears for workflows that exist on the **default branch (master)**. If you've added or modified a workflow in a feature branch, you won't see the button until the workflow is merged to master.
115+
116+
To manually trigger a workflow in the GitHub UI:
117+
118+
1. Go to the **Actions** tab in the repository
119+
2. Select the workflow from the left sidebar (e.g., "JS unit tests for Renderer package")
120+
3. Click the **"Run workflow"** dropdown button (top right)
121+
4. Select the branch you want to run it on
122+
5. Configure any input parameters (e.g., `force_run` to bypass change detection)
123+
6. Click **"Run workflow"**
124+
125+
### Using the GitHub CLI
126+
127+
You can trigger workflows from the command line without waiting for them to be merged to master:
128+
129+
```bash
130+
# Basic manual trigger on current branch
131+
gh workflow run package-js-tests.yml
132+
133+
# Trigger on a specific branch (e.g., master)
134+
gh workflow run package-js-tests.yml --ref master
135+
136+
# Trigger with force_run parameter to bypass change detection
137+
gh workflow run package-js-tests.yml --ref master -f force_run=true
138+
139+
# List available workflows
140+
gh workflow list
141+
142+
# View recent workflow runs
143+
gh run list --workflow=package-js-tests.yml
144+
```
145+
146+
### Workflows Supporting Manual Triggers
147+
148+
The following workflows can be manually triggered with `workflow_dispatch`:
149+
150+
- **`package-js-tests.yml`** - Accepts `force_run` parameter (boolean) to bypass change detection
151+
- **`main.yml`** - Accepts `force_run` parameter (boolean) to bypass change detection
152+
- **`lint-js-and-ruby.yml`** - Accepts `force_run` parameter (boolean) to bypass change detection
153+
- **`rspec-package-specs.yml`** - Accepts `force_run` parameter (boolean) to bypass change detection
154+
- **`playwright.yml`** - Can be triggered manually
155+
- And others - check individual workflow files for `workflow_dispatch` configuration
156+
157+
### Why Use Manual Triggers?
158+
159+
- **Test workflow changes** before merging (via CLI only until merged to master)
160+
- **Re-run CI on master** without making a new commit
161+
- **Force full test suite** on a branch using `force_run=true`
162+
- **Debug CI issues** by running workflows on specific commits
163+
108164
## Conditional Execution
109165

110166
Many workflows use change detection to skip unnecessary jobs:

0 commit comments

Comments
 (0)