* docs(chezmoi): fix using underscores as delimiters in docs, when code uses dashes this apparently was just a documentation problem, not an actual issue * fix: change enable-all-users to all-users * docs: change remaining underscores in readme to dashes * fix: remove install-chezmoi key * fix: rename changed-file-policy to file-conflict-policy
20 lines
1.4 KiB
YAML
20 lines
1.4 KiB
YAML
name: chezmoi
|
|
shortdesc: The chezmoi module installs the latest chezmoi release at build time, along with services to clone a dotfile repository and keep it up-to-date.
|
|
readme: https://raw.githubusercontent.com/blue-build/modules/main/modules/chezmoi/README.md
|
|
example: |
|
|
type: chezmoi
|
|
# Git repository to initialize
|
|
repository: "https://example.org/user/dotfiles" # Required - Default: n/a - Expects type: string
|
|
# Whether to enable the modules services globally for all users, if false users need to enable services manually
|
|
all-users: true # Optional - Default: true - Expects type: boolean
|
|
# Dotfiles will be updated with this interval
|
|
run-every: '1d' # Optional - Default: '1d' - Expects type: string
|
|
# Dotfile updates will wait this long after a boot before running
|
|
wait-after-boot: '5m' # Optional - Default: '5m' - Expects type: string
|
|
# Disable the service that initializes `repository` on users that are logged in or have linger enabled
|
|
disable-init: false # Optional - Default: false - Expects type: boolean
|
|
# Disable the timer that updates chezmoi with the interval set above
|
|
disable-update: false # Optional - Default: false - Expects type: boolean
|
|
# What to do when file different that exists on your repo is has been changed or exists locally. Accepts "skip" or "replace"
|
|
file-conflict-policy: "skip" # Optional - Default: "skip" - Expects type: string
|
|
|