Skip to content

Commit 6ae8377

Browse files
update documentation to describe the backoff
1 parent d23efe7 commit 6ae8377

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,14 @@ The only required input is `project-name`.
6060
The default value is 30.
6161

6262
1. **update-back-off** (optional) :
63-
Back-off time in seconds for the update interval.
63+
Base back-off time in seconds for the update interval.
6464

65-
When API rate-limiting is hit, the back-off time will be added to the next update
66-
interval.
65+
When API rate-limiting is hit the back-off time, augmented with jitter, will be
66+
added to the next update interval.
6767
E.g. with update interval of 30 and back-off time of 15, upon hitting the rate-limit
68-
the next interval for the update call will be 45s and if the rate-limit is hit again
69-
the next interval will be 60s and so on.
68+
the next interval for the update call will be 30 + random_between(0, 15 _ 2 \*\* 0))
69+
seconds and if the rate-limit is hit again the next interval will be
70+
30 + random_between(0, 15 _ 2 \*\* 1) and so on.
7071

7172
The default value is 15.
7273

action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ inputs:
2626
description: 'How often the action calls the API for updates'
2727
required: false
2828
update-back-off:
29-
description: 'Back-off time for the update calls for API if rate-limiting is encountered'
29+
description: 'Base back-off time for the update calls for API if rate-limiting is encountered'
3030
required: false
3131

3232
outputs:

0 commit comments

Comments
 (0)