Skip to content
This repository has been archived by the owner on Jan 23, 2021. It is now read-only.

Commit

Permalink
fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
ahelal committed Aug 28, 2017
1 parent 98341d3 commit b0130fc
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# bender Resource

A Concourse resource that can trigger any job (deployments, releases, ...) using slack.
Check [examples](#Examples)

Check [examples](examples.md) page for usage.

## Source Configuration

Expand All @@ -11,7 +12,7 @@ Check [examples](#Examples)

* `bot_name`: *Optional*, *default `bender`*. The bot name will be used to identify and filter messages. All messages must be addressed to the bot, eg.: `@bot_name some message`.

* `grammar`: *Optional.* If not defined bender will respond to all mentions `@bot_name` and If grammar is defined bender will **only** respond to messages matching the regex expression. Use [python regular expression](https://docs.python.org/2/library/re.html) syntax. See [examples](#Examples) for inspiration.
* `grammar`: *Optional.* If not defined bender will respond to all mentions `@bot_name` and If grammar is defined bender will **only** respond to messages matching the regex expression. Use [python regular expression](https://docs.python.org/2/library/re.html) syntax. See [examples](examples.md) page. for inspiration.

* `template`: *Optional*. A string that will be evaluated and written to `template_filename` can be used as an input file for further jobs in the pipeline.

Expand All @@ -31,7 +32,7 @@ Check accepts no params.

A file **bender.json** will be created with the message payload.

if `template` is defined it will be evaluated and written to `template_filename`. For more info on template syntax read [Template section](#Template). For example on usage, check the [examples](#Examples) section.
if `template` is defined it will be evaluated and written to `template_filename`. For more info on template syntax read [template section](#template). For example on usage, check the [examples](examples.md) page.

#### `in Parameters`

Expand All @@ -45,7 +46,7 @@ Replies to the original message in a thread format.

* `path`: *Required.* The path of the resource name.

* `reply`: *Required.* The message to be used as reply. Supports [template format](#Template).
* `reply`: *Required.* The message to be used as reply. Supports [template format](#template).

### Template

Expand Down Expand Up @@ -78,10 +79,6 @@ The template uses python [Jinja2](http://jinja.pocoo.org/docs/2.9/) engine.
* If you have multiple triggers on the same channel it is better to use a different bot token for each. check TODO
## Examples
Check [examples.md](examples.md)
## TODO
* At the moment Bender depend on `timestamp` and slack to mark last as message read. Usually concourse should handle this natively with *check* version. Using **slack unread message** will improve speed, but downside you can't have multiple triggers per channel with same token. This only affects the check method. So need to support native concourse resource checks too.
Expand Down

0 comments on commit b0130fc

Please sign in to comment.