Skip to content

Commit e37d5f7

Browse files
committed
Update README
1 parent c9569c4 commit e37d5f7

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Slash Command Dispatch
22
[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-Slash%20Command%20Dispatch-blue.svg?colorA=24292e&colorB=0366d6&style=flat&longCache=true&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAOCAYAAAAfSC3RAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAM6wAADOsB5dZE0gAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAAERSURBVCiRhZG/SsMxFEZPfsVJ61jbxaF0cRQRcRJ9hlYn30IHN/+9iquDCOIsblIrOjqKgy5aKoJQj4O3EEtbPwhJbr6Te28CmdSKeqzeqr0YbfVIrTBKakvtOl5dtTkK+v4HfA9PEyBFCY9AGVgCBLaBp1jPAyfAJ/AAdIEG0dNAiyP7+K1qIfMdonZic6+WJoBJvQlvuwDqcXadUuqPA1NKAlexbRTAIMvMOCjTbMwl1LtI/6KWJ5Q6rT6Ht1MA58AX8Apcqqt5r2qhrgAXQC3CZ6i1+KMd9TRu3MvA3aH/fFPnBodb6oe6HM8+lYHrGdRXW8M9bMZtPXUji69lmf5Cmamq7quNLFZXD9Rq7v0Bpc1o/tp0fisAAAAASUVORK5CYII=)](https://github.com/marketplace/actions/slash-command-dispatch)
33

4-
A GitHub action that facilitates "ChatOps" by creating repository dispatch events for slash commands.
4+
A GitHub action that facilitates ["ChatOps"](https://www.pagerduty.com/blog/what-is-chatops/) by creating repository dispatch events for slash commands.
55

66
### How does it work?
77

8-
The action runs in `on: issue_comment` workflows and checks comments for slash commands.
8+
The action runs in `issue_comment` event workflows and checks comments for slash commands.
99
When a valid command is found it creates a repository dispatch event that includes a payload containing full details of the command and its context.
1010

1111
### Why repository dispatch?
@@ -15,14 +15,14 @@ In repositories with a lot of activity, the workflow queue will get backed up ve
1515

1616
Dispatching commands to be processed elsewhere keeps the workflow queue moving quickly. It essentially allows you to run multiple workflow queues in parallel.
1717

18-
### Advantages of slash-command-dispatch
18+
### Key features
1919

2020
- Easy configuration of "ChatOps" slash commands
21-
- Separating the queue of `issue_comment` events from the queue of commands to process keeps it fast moving
21+
- Enables separating the queue of `issue_comment` events from the queue of commands to process to keep it fast moving
2222
- Users receive faster feedback that commands have been seen and are waiting to be processed
23-
- The ability to handle processing workloads in multiple repositories in parallel
23+
- The ability to handle processing commands in multiple repositories in parallel
2424
- Long running workloads can be processed in a repository workflow queue of their own
25-
- Even if commands are processed in the same repository, separation of comment parsing and command processing logic allows easier management of "ChatOps" use cases
25+
- Even if commands are dispatched and processed in the same repository, separation of comment parsing and command processing makes workflows more maintainable, and with less duplication
2626

2727
### Demo
2828

0 commit comments

Comments
 (0)