Propose fix to Dependabot documentation (#58315)
This commit is contained in:
@@ -607,7 +607,9 @@ Reviewers must have at least read access to the repository.
|
|||||||
| `interval` | **Required.** Defines the frequency for {% data variables.product.prodname_dependabot %}. |
|
| `interval` | **Required.** Defines the frequency for {% data variables.product.prodname_dependabot %}. |
|
||||||
| `day` | Specify the day to run for a **weekly** interval. |
|
| `day` | Specify the day to run for a **weekly** interval. |
|
||||||
| `time` | Specify the time to run. |
|
| `time` | Specify the time to run. |
|
||||||
|
| {% ifversion dependabot-schedule-updates %} |
|
||||||
| `cronjob` | Defines the cron expression if the interval type is `cron`. |
|
| `cronjob` | Defines the cron expression if the interval type is `cron`. |
|
||||||
|
| {% endif %} |
|
||||||
| `timezone` | Specify the timezone of the `time` value. |
|
| `timezone` | Specify the timezone of the `time` value. |
|
||||||
|
|
||||||
{% ifversion fpt or ghec %}
|
{% ifversion fpt or ghec %}
|
||||||
@@ -630,18 +632,18 @@ Each package manager **must** define a schedule interval.
|
|||||||
|
|
||||||
### `interval`
|
### `interval`
|
||||||
|
|
||||||
Supported values: `daily`, `weekly`, `monthly`, or `cron`
|
Supported values: `daily`, `weekly`, `monthly`{% ifversion dependabot-schedule-updates %}, or `cron`{% endif %}
|
||||||
|
|
||||||
Each package manager **must** define a schedule interval.
|
Each package manager **must** define a schedule interval.
|
||||||
|
|
||||||
* Use `daily` to run on every weekday, Monday to Friday.
|
* Use `daily` to run on every weekday, Monday to Friday.
|
||||||
* Use `weekly` to run once a week, by default on Monday.
|
* Use `weekly` to run once a week, by default on Monday.
|
||||||
* Use `monthly` to run on the first day of each month.
|
* Use `monthly` to run on the first day of each month.{% ifversion dependabot-schedule-updates %}
|
||||||
* Use `cron` for cron expression based scheduling option. See [`cronjob`](#cronjob).
|
* Use `cron` for cron expression based scheduling option. See [`cronjob`](#cronjob).{% endif %}
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
By default, {% data variables.product.prodname_dependabot %} randomly assigns a time to apply all the updates in the configuration file. You can use the `time` and `timezone` parameters to set a specific runtime for all intervals. If you use a `cron` interval, you can define the update time with a `cronjob` expression.
|
By default, {% data variables.product.prodname_dependabot %} randomly assigns a time to apply all the updates in the configuration file. You can use the `time` and `timezone` parameters to set a specific runtime for all intervals. {% ifversion dependabot-schedule-updates %}If you use a `cron` interval, you can define the update time with a `cronjob` expression.{% endif %}
|
||||||
|
|
||||||
### `day`
|
### `day`
|
||||||
|
|
||||||
@@ -655,6 +657,8 @@ Format: `hh:mm`
|
|||||||
|
|
||||||
Optionally, run all updates for a package manager at a specific time of day. By default, times are interpreted as UTC.
|
Optionally, run all updates for a package manager at a specific time of day. By default, times are interpreted as UTC.
|
||||||
|
|
||||||
|
{% ifversion dependabot-schedule-updates %}
|
||||||
|
|
||||||
### `cronjob`
|
### `cronjob`
|
||||||
|
|
||||||
Supported values: Valid cron expression in cron syntax or natural expression.
|
Supported values: Valid cron expression in cron syntax or natural expression.
|
||||||
@@ -684,6 +688,8 @@ updates:
|
|||||||
cronjob: "0 9 * * *"
|
cronjob: "0 9 * * *"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
### `timezone`
|
### `timezone`
|
||||||
|
|
||||||
Specify a time zone for the `time` value.
|
Specify a time zone for the `time` value.
|
||||||
|
|||||||
6
data/features/dependabot-schedule-updates.yml
Normal file
6
data/features/dependabot-schedule-updates.yml
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
# Reference: #17004
|
||||||
|
# Dependabot `schedule` enhancements [GA]
|
||||||
|
versions:
|
||||||
|
fpt: '*'
|
||||||
|
ghec: '*'
|
||||||
|
ghes: '> 3.17'
|
||||||
Reference in New Issue
Block a user