docs: update workflow input

olegsu · Dec 5, 2021 · e155de2 · e155de2
1 parent 6d9e880
commit e155de2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -1,9 +1,8 @@
 
 name: docs
 
-on:
-  push:
-    branches: [ 'main' ]
+on: workflow_dispatch
+
 concurrency: docs-release 
 jobs:
   deploy:

diff --git a/docs/index.md b/docs/index.md
@@ -16,7 +16,9 @@ use: bot # change me
 * `/? help`
 * `/? label {name}` - adds a label, creating new one if not exists
 * `/? merge` - squash merge the pull request
-* `/? workflow {name}` - uses workflow dispatch event api to trigger worklfow. The workflow must have `on: workflow_dispatch`.
+* `/? workflow {name} {key=value} {key=value}` - uses workflow dispatch event api to trigger worklfow. The workflow must have `on: workflow_dispatch`.
+  * `{name}` the file name of the worklfow (release.yaml)
+  * `{key=value}` key and value pairs to pass as an input to the workflow
 
 ### Permissions
 Only a commands from the repository owner will be accepted.