Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(schedule/timezone): rewrite #31997

Merged
merged 1 commit into from
Oct 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 19 additions & 9 deletions docs/usage/configuration-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -3778,9 +3778,15 @@ We recommend you do this selectively with `packageRules` and not globally.

The `schedule` option allows you to define times of the day, week or month when you are willing to allow Renovate to create branches.

Setting a `schedule` does not itself cause or trigger Renovate to run. It's like putting a sign on your office which says "DHL deliveries only accepted between 9-11am". Such a sign won't _cause_ DHL to come to your office only at 9-11am, instead it simply means that if they come at any other time of the day then they'll honor the sign and skip you. It also means that if they rarely attempt between 9-11am then you'll often get no deliveries in a day. Similarly, if you set too restrictive of a Renovate `schedule` and the chance of Renovate running on your repo during those hours is low, then you might find your dependency updates regularly skipped. For this reason we recommend you usually allow a time window of at least 3-4 hours in any `schedule` unless your instance of Renovate is expected to run more frequently than that.
Setting a `schedule` does not itself cause or trigger Renovate to run.
It's like putting a sign on your office which says "DHL deliveries only accepted between 9-11am".
Such a sign won't _cause_ DHL to come to your office only at 9-11am, instead it simply means that if they come at any other time of the day then they'll honor the sign and skip you.
It also means that if they rarely attempt between 9-11am then you'll often get no deliveries in a day.

Renovate supports the standard [Cron syntax](https://crontab.guru/crontab.5.html) as well as deprecated support for a subset of [Later syntax](https://github.com/breejs/later).
Similarly, if you set too restrictive of a Renovate `schedule` and the chance of Renovate running on your repo during those hours is low, then you might find your dependency updates regularly skipped.
For this reason we recommend you allow a time window of at least 3-4 hours in any `schedule`, unless your instance of Renovate is expected to run more frequently than that.

Renovate supports the standard [Cron syntax](https://crontab.guru/crontab.5.html), as well as deprecated support for a subset of [Later syntax](https://github.com/breejs/later).
We recommend you always use Cron syntax, due to its superior testing and robustness.
Config support questions are no longer accepted for Later syntax problems - you will be recommended to use Cron instead.

Expand All @@ -3794,11 +3800,11 @@ Here are some example schedules and their Cron equivalent:

| English description | Supported by Later? | Cron syntax |
| -------------------------------------------- | ------------------- | --------------------- |
| every weekend | | `* * * * 0,6` |
| before 5:00am | | `* 0-4 * * *` |
| after 10pm and before 5am every weekday | | `* 22-23,0-4 * * 1-5` |
| on friday and saturday | | `* * * * 5,6` |
| every 3 months on the first day of the month | | `* * 1 */3 *` |
| every weekend | Yes | `* * * * 0,6` |
| before 5:00am | Yes | `* 0-4 * * *` |
| after 10pm and before 5am every weekday | Yes | `* 22-23,0-4 * * 1-5` |
| on friday and saturday | Yes | `* * * * 5,6` |
| every 3 months on the first day of the month | Yes | `* * 1 */3 *` |

<!-- prettier-ignore -->
!!! note
Expand All @@ -3813,7 +3819,7 @@ You could then configure a schedule like this at the repository level:
}
```

This would mean that Renovate can run for 7 hours each night plus all the time on weekends.
This would mean that Renovate can run for 7 hours each night, plus all the time on weekends.
Note how the above example makes use of the "OR" logic of combining multiple schedules in the array.

It's common to use `schedule` in combination with [`timezone`](#timezone).
Expand Down Expand Up @@ -3939,7 +3945,11 @@ The above config will suppress the comment which is added to a PR whenever you c

## timezone

It is only recommended to configure this field if you wish to use the `schedule` feature and want them evaluated in your local timezone.
We recommend that you only configure the `timezone` option if _both_ of these are true:

- you want to use the `schedule` feature
- _and_ you want Renovate to evaluate the `schedule` in local timezone

Please see the above link for valid timezone names.

## updateInternalDeps
Expand Down
Loading