Skip to content

Commit 6cfb5be

Browse files
authored
Merge pull request #622 from linear-b/run-github-workflow-improvments
update run github workflow doc
2 parents ffc8d54 + 988b2a8 commit 6cfb5be

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/automation-actions.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -365,13 +365,13 @@ This action, once triggered, will start a workflow dispatch automation with the
365365

366366
| Args | Usage | Type | Description |
367367
| ----------------------- | -------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
368-
| `workflow` | Required | String | The ID or name of the workflow dispatch. |
369-
| `owner` | Optional | String | By default, the value of `repo.owner` context variable. The account owner of the repository. Case insensitive. |
370-
| `repo` | Optional | String | By default, the value of `repo.name` context variable. The name of the repository without the `.git` extension. Case insensitive. |
371-
| `ref` | Optional | String | By default, the value of `branch.name` context variable. The account owner of the repository. Case insensitive. |
368+
| `workflow` | Required | String | The ID or the path of the workflow dispatch. |
369+
| `owner` | Optional | String | By default, the value of `repo.owner` context variable. The account owner of the repository. Case insensitive. |
370+
| `repo` | Optional | String | By default, the value of `repo.name` context variable. The name of the repository without the `.git` extension. Case insensitive. |
371+
| `ref` | Optional | String | By default, the value of `branch.name` context variable. The branch name. Case sensitive. |
372372
| `inputs` | Optional | String | By default, an empty list. Key-Value list with the arguments to provide to the workflow |
373373
| `check_name` | Optional | String | When added, after the workflow is complete, add the check name to the checks list on GitHub |
374-
| `stop_ongoing_workflow` | Optional | Bool | By default, `false`. In case the workflow already runs on the branch, if `true`: cancel the ongoing workflow before running the newly dispatched workflow. If `false`: wait for the old workflow to finish before dispatching a new one |
374+
| `stop_ongoing_workflow` | Optional | Bool | By default, `false`. If the workflow already runs on the branch, When `true`: cancel the ongoing workflow before running the newly dispatched workflow. When `false`: wait for the old workflow to finish before dispatching a new one |
375375

376376
</div>
377377

@@ -397,8 +397,9 @@ has:
397397

398398
!!! attention
399399

400-
* This action will invoke the run of a workflow dispatch; thus, it might result in significant GitHub action minutes charge.
400+
* This action will invoke the run of a workflow dispatch; thus, it might result in a significant GitHub action minutes charge.
401401
* We encourage you to use this action with [custom triggers](./execution-model.md#explicit-triggers)
402+
* To manually test the webhook dispatch, please [run the workflow](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/manually-running-a-workflow#running-a-workflow){:target="_blank"} before using it with gitStream.
402403

403404
#### `send-http-request` :fontawesome-brands-github:
404405

0 commit comments

Comments
 (0)