Skip to content

Commit 45cd287

Browse files
committed
Update documentation
1 parent db9b8b7 commit 45cd287

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ In repositories with a lot of activity, the workflow queue will get backed up ve
1717

1818
Dispatching commands to be processed elsewhere keeps the workflow queue moving quickly. It essentially enables parallel processing of workflows.
1919

20-
A additional benefit of dispatching is that it allows non-sensitive workloads to be run in public repositories to save using private repository GitHub Action minutes.
20+
An additional benefit of dispatching is that it allows non-sensitive workloads to be run in public repositories to save using private repository GitHub Action minutes.
2121

2222
<div align="center"><img src="docs/assets/slash-command-dispatch.png" width="550"></div>
2323

@@ -63,7 +63,7 @@ jobs:
6363
build-docs
6464
```
6565
66-
Note that not specifying the `repository` input will mean that dispatch events are created in the *current* repository by default. It's perfectly fine to use the current repository and not dispatch events to a seperate "processor" repository.
66+
Note that not specifying the `repository` input will mean that dispatch events are created in the *current* repository by default. It's perfectly fine to use the current repository and not dispatch events to a separate "processor" repository.
6767

6868
This action also features [advanced configuration](docs/advanced-configuration.md) that allows each command to be configured individually if necessary. Use the standard configuration shown above unless you require advanced features.
6969

@@ -169,7 +169,7 @@ Commands are dispatched with a payload containing a number of contexts.
169169
#### `slash_command` context
170170

171171
The slash command context contains the command and any arguments that were supplied by the user.
172-
It will also contain any static arguments, if configured.
172+
It will also contain any static arguments if configured.
173173

174174
To demonstrate, take the following configuration as an example.
175175
```yml

docs/advanced-configuration.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What is advanced configuration?
44

5-
Due to the limitations of yaml based action inputs, basic configuration is not adequate enough to support unique configuration *per command*.
5+
Due to the limitations of YAML based action inputs, basic configuration is not adequate to support unique configuration *per command*.
66

77
For example, the following basic configuration means that all commands must have the same `admin` permission.
88

@@ -22,7 +22,7 @@ To solve this issue, advanced JSON configuration allows each command to be confi
2222
2323
## Dispatching commands
2424
25-
There are two ways to specify JSON configuration for command dispatch. Directly in the workflow via the `config` input, OR, specifing a JSON config file via the `config-from-file` input.
25+
There are two ways to specify JSON configuration for command dispatch. Directly in the workflow via the `config` input, OR, specifying a JSON config file via the `config-from-file` input.
2626

2727
**Note**: It is recommended to write the JSON configuration directly in the workflow rather than use a file. Using the `config-from-file` input will be slightly slower due to requiring the repository to be checked out with `actions/checkout` so the file can be accessed.
2828

@@ -92,7 +92,7 @@ jobs:
9292

9393
## Advanced action inputs
9494

95-
Advanced configuration requires a combination of yaml based inputs and JSON configuration.
95+
Advanced configuration requires a combination of YAML based inputs and JSON configuration.
9696

9797
| Input | JSON Property | Description | Default |
9898
| --- | --- | --- | --- |

docs/examples.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## Use case: Execute command using a specific repository branch
1111

12-
This is pattern for a slash command where a named argument specifies the branch to checkout. If the named argument is missing it defaults to `master`. For example, the following command will cause the command workflow to checkout the `develop` branch of the repository where the command was dispatched from. After the branch has been checked out in the command workflow, scripts, tools or actions may be executed against it.
12+
This is a pattern for a slash command where a named argument specifies the branch to checkout. If the named argument is missing it defaults to `master`. For example, the following command will cause the command workflow to checkout the `develop` branch of the repository where the command was dispatched from. After the branch has been checked out in the command workflow, scripts, tools or actions may be executed against it.
1313

1414
```
1515
/do-something branch=develop
@@ -121,7 +121,7 @@ jobs:
121121
122122
## Use case: Execute command to modify a pull request branch
123123
124-
This is pattern for a slash command used in pull request comments. It checks out the pull request branch and allows further scripts, tools and action steps to modify it.
124+
This is a pattern for a slash command used in pull request comments. It checks out the pull request branch and allows further scripts, tools and action steps to modify it.
125125
126126
```
127127
/fix-pr

docs/updating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
/send "hello world!"
6666
```
6767

68-
- The `commands` input can now be newline separated, or comma separated.
68+
- The `commands` input can now be newline separated, or comma-separated.
6969

7070
e.g.
7171
```yml

0 commit comments

Comments
 (0)