Skip to content

Commit

Permalink
Update token shortcut info section
Browse files Browse the repository at this point in the history
  • Loading branch information
BunnyDunker committed Nov 28, 2023
1 parent ce5c1d3 commit dca63db
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,19 @@ config :slax, Slax.Slack,
```./bin/server```
All commands provide usage details when executing them without any parameters.

### /token
This is a slack shortcut that is an interactive series of modals to setup project repo connections in the database as well as store fine grained access tokens to enable issue lookup and poker functionality. **This is necessary** for proper functionality of Issue/PR lookup and Poker.

The first modal you see lets you select a Repo and attach an access token and expiration date to it.
The second modal is accessed by clicking Create Repo and lets you either select or create a new Project and attach a Repo to the Project

To generate a fine grained access token go to https://github.com/settings/tokens?type=beta and fill out the form. Check `Only Select Repositories` and select the desired repo(s). Under Repository Permissions, give at least Read and write to `Issues` and Read only to `Pull Requests`

### Issue & PR lookup
With the websocket connection slax parses every message for the specified patterns corresponding to an issue `org/repo#1` `repo#1` or a PR `org/repo$1` `repo$1`
With the websocket connection slax parses every message for the specified patterns corresponding to an issue `org/repo#1` `repo#1` or a PR `org/repo$1` `repo$1`.

### /poker
This command is the interaction point for the poker feature and when just typing `/poker` it will respond with a help message on how to use it

### /token
This is a slack shortcut that is an interactive series of modals to setup project repo connections in the database as well as store fine grained access tokens to enable issue lookup and poker functionality
This command is the interaction point for the poker feature and when just typing `/poker` it will respond with a help message on how to use it.

### _The following commands have not been tested or used in a while_

Expand Down

0 comments on commit dca63db

Please sign in to comment.