Skip to content

Commit

Permalink
docs: add entry in readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Ricardo Souza committed Aug 4, 2020
1 parent 9289fbb commit c97bfc0
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,24 @@ steps:
MERGE_METHOD: MERGE
```

### Number of retries

In case the merge action fails, by default it will automatically be retried up
to three times using an exponential backoff strategy. This means, the first
retry will happen 1 second after the first failure, while the second will happen
4 seconds after the previous, the third 9 seconds, and so on.

It's possible to configure the number of retries by providing a value for
`NUMBER_OF_RETRIES` (by default, the value is `3`).

```yaml
steps:
- name: Merge me!
uses: ridedott/merge-me-action@master
with:
NUMBER_OF_RETRIES: 2
```

## Getting Started

These instructions will get you a copy of the project up and running on your
Expand Down

0 comments on commit c97bfc0

Please sign in to comment.