Skip to main content

path_repo_updates

Parameters

Configuration for the automated updates of the repositories in omni path.

ParameterTypeDescription
enabledbooleanwhether or not automated updates are enabled (default: true)
self_updateenum: true, false, ask, nocheckwhether to update omni if a new release is found (false will check for release but only show a message, true will automatically install any new release, ask will ask the user and nocheck will entirely skip checking for updates
pre_authbooleanwhether or not to allow pre-auth before updates; pre-auth allows to trigger the authorization process for hosts before updates happen concurrently, avoiding asking multiple authorizations for the same host, at the cost of one extra git call per host (default: true)
pre_auth_timeoutdurationthe duration after which a pre-auth timeouts (default: 2m)
background_updatesbooleanwhether or not to allow background updates of the repositories (default: true)
background_updates_timeoutdurationthe number of seconds after which a background update timeouts (default: 1h)
on_command_not_foundenum: true, false, askwhether to trigger an update when a command is not found (default: ask)
intervaldurationthe number of seconds to wait between two updates of the repositories (default: 12h)
ref_typeenum: branch or tagthe type of ref that is being used for updates (default: branch)
ref_matchregexa string representing the regular expression to match the ref name when doing an update; using null is equivalent to matching everything (default: null)
per_repo_configmap of per_repo_configoverride of the update configuration per repository, the keys must be in the format host:owner/repo

Example

path_repo_updates:
enabled: true
self_update: ask
pre_auth: true
pre_auth_timeout: 120 # 2 minutes
background_updates: true
background_updates_timeout: 3600 # 1 hour
on_command_not_found: ask
interval: 43200 # 12 hours
ref_type: "branch" # branch or tag
ref_match: null # regex or null
per_repo_config: {}