psi-jack/yadm
1
0
Fork 0
mirror of synced 2024-12-21 14:11:08 -05:00
Code Issues Releases Wiki Activity

Update version number and update documentation

Browse source 
* Support spaces in distro/distro-family (#432)
* Fix zsh hanging when tab completing add/checkout (#417)
* Add yadm-untracked script to contributed files (#418)
* Fix documentation typos (#425)
* Support docker-like OCI engines for dev testing (#431)
This commit is contained in:
Tim Byrne 2023-01-23 13:25:54 -06:00
parent 5981f6329e
commit 2d4dcd05ef
No known key found for this signature in database
GPG key ID: 14DB4FC2465A4B12
7 changed files with 157 additions and 150 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
CHANGES
View file

@ -1,3 +1,10 @@
3.2.2
* Support spaces in distro/distro-family (#432)
* Fix zsh hanging when tab completing add/checkout (#417)
* Add yadm-untracked script to contributed files (#418)
* Fix documentation typos (#425)
* Support docker-like OCI engines for dev testing (#431)
3.2.1
* Fix Bash 3 bad array subscript bug (#411)

6
CONTRIBUTORS
View file

@ -12,8 +12,12 @@ Espen Henriksen
Cameron Eagans
Klas Mellbourn
James Clark
Glenn Waters
Nicolas signed-log FORMICHELLA
Tomas Cernaj
Joshua Cold
jonasc
Nicolas stig124 FORMICHELLA
Chad Wade Day, Jr
Sébastien Gross
David Mandelberg
@ -26,7 +30,6 @@ Siôn Le Roux
Mateusz Piotrowski
Uroš Golja
Satoshi Ohki
Nicolas stig124 FORMICHELLA
Jonas
Franciszek Madej
Daniel Wagenknecht
@ -46,3 +49,4 @@ Thomas Luzat
Russ Allbery
Brayden Banks
Alexandre GV
Felipe S. S. Schneider

2
README.md
View file

@ -72,7 +72,7 @@ The star count helps others discover yadm.
[master-badge]: https://img.shields.io/github/workflow/status/TheLocehiliosan/yadm/Tests/master?label=master
[master-commits]: https://github.com/TheLocehiliosan/yadm/commits/master
[master-date]: https://img.shields.io/github/last-commit/TheLocehiliosan/yadm/master.svg?label=master
[obs-badge]: https://img.shields.io/badge/OBS-v3.2.1-blue
[obs-badge]: https://img.shields.io/badge/OBS-v3.2.2-blue
[obs-link]: https://software.opensuse.org//download.html?project=home%3ATheLocehiliosan%3Ayadm&package=yadm
[releases-badge]: https://img.shields.io/github/tag/TheLocehiliosan/yadm.svg?label=latest+release
[releases-link]: https://github.com/TheLocehiliosan/yadm/releases

4
yadm
View file

@ -1,6 +1,6 @@
#!/bin/sh
# yadm - Yet Another Dotfiles Manager
# Copyright (C) 2015-2022 Tim Byrne
# Copyright (C) 2015-2023 Tim Byrne
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
@ -21,7 +21,7 @@ if [ -z "$BASH_VERSION" ]; then
[ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
fi
VERSION=3.2.1
VERSION=3.2.2
YADM_WORK="$HOME"
YADM_DIR=

2
yadm.1
View file

@ -1,5 +1,5 @@
.\" vim: set spell so=8:
.TH yadm 1 "17 March 2022" "3.2.1"
.TH yadm 1 "23 January 2023" "3.2.2"
.SH NAME

186
yadm.md
View file

@ -42,7 +42,7 @@
## DESCRIPTION
yadm is a tool for managing a collection of files across multiple com-
yadm is a tool for managing a collection of files across multiple com‐
puters, using a shared Git repository. In addition, yadm provides a
feature to select alternate versions of files for particular systems.
Lastly, yadm supplies the ability to manage a subset of secure files,
@ -52,11 +52,11 @@
## COMMANDS
git-command or git-alias
Any command not internally handled by yadm is passed through to
git(1). Git commands or aliases are invoked with the yadm man-
git(1). Git commands or aliases are invoked with the yadm man‐
aged repository. The working directory for Git commands will be
the configured work-tree (usually $HOME).
Dotfiles are managed by using standard git commands; add, com-
Dotfiles are managed by using standard git commands; add, com‐
mit, push, pull, etc.
The config command is not passed directly through. Instead use
@ -64,18 +64,18 @@
alt Create symbolic links and process templates for any managed
files matching the naming rules described in the ALTERNATES and
TEMPLATES sections. It is usually unnecessary to run this com-
TEMPLATES sections. It is usually unnecessary to run this com‐
mand, as yadm automatically processes alternates by default.
This automatic behavior can be disabled by setting the configu-
This automatic behavior can be disabled by setting the configu‐
ration yadm.auto-alt to "false".
bootstrap
Execute $HOME/.config/yadm/bootstrap if it exists.
clone url
Clone a remote repository for tracking dotfiles. After the con-
Clone a remote repository for tracking dotfiles. After the con‐
tents of the remote repository have been fetched, a "check out"
of the remote HEAD branch is attempted. If there are conflict-
of the remote HEAD branch is attempted. If there are conflict‐
ing files already present in the work-tree, the local version
will be left unmodified and you'll have to review and resolve
the difference.
@ -84,12 +84,12 @@
By default, $HOME will be used as the work-tree, but this can be
overridden with the -w option. yadm can be forced to overwrite
an existing repository by providing the -f option. If you want
to use a branch other than the remote HEAD branch you can spec-
to use a branch other than the remote HEAD branch you can spec‐
ify it using the -b option. By default yadm will ask the user
if the bootstrap program should be run (if it exists). The
options --bootstrap or --no-bootstrap will either force the
bootstrap to be run, or prevent it from being run, without
prompting the user.
if the bootstrap program should be run (if it exists). The op‐
tions --bootstrap or --no-bootstrap will either force the boot‐
strap to be run, or prevent it from being run, without prompting
the user.
config This command manages configurations for yadm. This command
works exactly the way git-config(1) does. See the CONFIGURATION
@ -102,7 +102,7 @@
without extracting them.
encrypt
Encrypt all files matching the patterns found in $HOME/.con-
Encrypt all files matching the patterns found in $HOME/.con‐
fig/yadm/encrypt. See the ENCRYPTION section for more details.
enter Run a sub-shell with all Git variables set. Exit the sub-shell
@ -116,7 +116,7 @@
of invoking your shell, that command will be run with all of the
Git variables exposed to the command's environment.
Emacs Tramp and Magit can manage files by using this configura-
Emacs Tramp and Magit can manage files by using this configura‐
tion:
(add-to-list 'tramp-methods
@ -130,9 +130,9 @@
With this config, use (magit-status "/yadm::").
git-crypt options
If git-crypt is installed, this command allows you to pass
options directly to git-crypt, with the environment configured
to use the yadm repository.
If git-crypt is installed, this command allows you to pass op‐
tions directly to git-crypt, with the environment configured to
use the yadm repository.
git-crypt enables transparent encryption and decryption of files
in a git repository. You can read https://github.com/AGWA/git-
@ -140,13 +140,13 @@
gitconfig
Pass options to the git config command. Since yadm already uses
the config command to manage its own configurations, this com-
mand is provided as a way to change configurations of the repos-
the config command to manage its own configurations, this com‐
mand is provided as a way to change configurations of the repos‐
itory managed by yadm. One useful case might be to configure
the repository so untracked files are shown in status commands.
yadm initially configures its repository so that untracked files
are not shown. If you wish use the default Git behavior (to
show untracked files and directories), you can remove this con-
show untracked files and directories), you can remove this con‐
figuration.
yadm gitconfig --unset status.showUntrackedFiles
@ -169,15 +169,15 @@
support command line completion.
perms Update permissions as described in the PERMISSIONS section. It
is usually unnecessary to run this command, as yadm automati-
is usually unnecessary to run this command, as yadm automati‐
cally processes permissions by default. This automatic behavior
can be disabled by setting the configuration yadm.auto-perms to
"false".
transcrypt options
If transcrypt is installed, this command allows you to pass
options directly to transcrypt, with the environment configured
to use the yadm repository.
If transcrypt is installed, this command allows you to pass op‐
tions directly to transcrypt, with the environment configured to
use the yadm repository.
transcrypt enables transparent encryption and decryption of
files in a git repository. You can read
@ -186,7 +186,7 @@
upgrade
Version 3 of yadm uses a different directory for storing data.
When you start to use version 3 for the first time, you may see
warnings about moving your data to this new directory. The eas-
warnings about moving your data to this new directory. The eas‐
iest way to accomplish this is by running "yadm upgrade". This
command will start by moving your yadm repo to the new path.
Next it will move any archive data. If the archive is tracked
@ -194,18 +194,18 @@
that file in the repo's index.
Upgrading will attempt to de-initialize and re-initialize your
submodules. If your submodules cannot be de-initialized, the
upgrade will fail. The most common reason submodules will fail
to de-initialize is because they have local modifications. If
you are willing to lose the local modifications to those submod-
ules, you can use the -f option with the "upgrade" command to
force the de-initialization.
submodules. If your submodules cannot be de-initialized, the up‐
grade will fail. The most common reason submodules will fail to
de-initialize is because they have local modifications. If you
are willing to lose the local modifications to those submodules,
you can use the -f option with the "upgrade" command to force
the de-initialization.
After running "yadm upgrade", you should run "yadm status" to
review changes which have been staged, and commit them to your
repository.
You can read https://yadm.io/docs/upgrade_from_2 for more infor-
You can read https://yadm.io/docs/upgrade_from_2 for more infor‐
mation.
version
@ -214,7 +214,7 @@
## OPTIONS
yadm supports a set of universal options that alter the paths it uses.
The default paths are documented in the FILES section. Any path speci-
The default paths are documented in the FILES section. Any path speci‐
fied by these options must be fully qualified. If you always want to
override one or more of these paths, it may be useful to create an
alias for the yadm command. For example, the following alias could be
@ -261,12 +261,12 @@
The following is the full list of supported configurations:
yadm.alt-copy
If set to "true", alternate files will be copies instead of sym-
If set to "true", alternate files will be copies instead of sym‐
bolic links. This might be desirable, because some systems may
not properly support symlinks.
yadm.auto-alt
Disable the automatic linking described in the section ALTER-
Disable the automatic linking described in the section ALTER‐
NATES. If disabled, you may still run "yadm alt" manually to
create the alternate links. This feature is enabled by default.
@ -275,10 +275,10 @@
$HOME/.config/yadm/encrypt. This feature is enabled by default.
yadm.auto-perms
Disable the automatic permission changes described in the sec-
Disable the automatic permission changes described in the sec‐
tion PERMISSIONS. If disabled, you may still run yadm perms
manually to update permissions. This feature is enabled by
default.
manually to update permissions. This feature is enabled by de‐
fault.
yadm.auto-private-dirs
Disable the automatic creating of private directories described
@ -287,20 +287,20 @@
yadm.cipher
Configure which encryption system is used by the encrypt/decrypt
commands. Valid options are "gpg" and "openssl". The default is
"gpg". Detailed information can be found in the section ENCRYP-
"gpg". Detailed information can be found in the section ENCRYP‐
TION.
yadm.git-program
Specify an alternate program to use instead of "git". By
default, the first "git" found in $PATH is used.
Specify an alternate program to use instead of "git". By de‐
fault, the first "git" found in $PATH is used.
yadm.gpg-perms
Disable the permission changes to $HOME/.gnupg/*. This feature
is enabled by default.
yadm.gpg-program
Specify an alternate program to use instead of "gpg". By
default, the first "gpg" found in $PATH is used.
Specify an alternate program to use instead of "gpg". By de‐
fault, the first "gpg" found in $PATH is used.
yadm.gpg-recipient
Asymmetrically encrypt files with a gpg public/private key pair.
@ -308,9 +308,9 @@
The key must exist in your public keyrings. Multiple recipients
can be specified (separated by space). If left blank or not
provided, symmetric encryption is used instead. If set to
"ASK", gpg will interactively ask for recipients. See the
ENCRYPTION section for more details. This feature is disabled
by default.
"ASK", gpg will interactively ask for recipients. See the EN‐
CRYPTION section for more details. This feature is disabled by
default.
yadm.openssl-ciphername
Specify which cipher should be used by openssl. "aes-256-cbc"
@ -337,13 +337,13 @@
local.class
Specify a class for the purpose of symlinking alternate files.
By default, no class will be matched. The local host can be
assigned multiple classes using command:
By default, no class will be matched. The local host can be as‐
signed multiple classes using command:
yadm config --add local.class <additional-class>
local.arch
Override the architecture for the purpose of symlinking alter-
Override the architecture for the purpose of symlinking alter‐
nate files.
local.hostname
@ -362,12 +362,12 @@
to have an automated way of choosing an alternate version of a file for
a different operating system, host, user, etc.
yadm will automatically create a symbolic link to the appropriate ver-
yadm will automatically create a symbolic link to the appropriate ver‐
sion of a file, when a valid suffix is appended to the filename. The
suffix contains the conditions that must be met for that file to be
used.
The suffix begins with "##", followed by any number of conditions sepa-
The suffix begins with "##", followed by any number of conditions sepa‐
rated by commas.
##<condition>[,<condition>,...]
@ -379,7 +379,7 @@
<attribute>[.<value>]
These are the supported attributes, in the order of the weighted prece-
These are the supported attributes, in the order of the weighted prece‐
dence:
@ -392,19 +392,19 @@
calculated by running id -u -n.
hostname, h
Valid if the value matches the short hostname. Hostname is cal-
Valid if the value matches the short hostname. Hostname is cal‐
culated by running uname -n, and trimming off any domain.
class, c
Valid if the value matches the local.class configuration. Class
must be manually set using yadm config local.class <class>. See
the CONFIGURATION section for more details about setting
local.class.
the CONFIGURATION section for more details about setting lo‐
cal.class.
distro, d
Valid if the value matches the distro. Distro is calculated by
running lsb_release -si or by inspecting the ID from /etc/os-
release.
running lsb_release -si or by inspecting the ID from /etc/os-re‐
lease.
distro_family, f
Valid if the value matches the distro family. Distro family is
@ -426,7 +426,6 @@
certain extension to e.g. make editors highlight the content
properly.
NOTE: The OS for "Windows Subsystem for Linux" is reported as "WSL",
even though uname identifies as "Linux".
@ -439,15 +438,15 @@
The "most appropriate" version is determined by calculating a score for
each version of a file. A template is always scored higher than any
symlink condition. The number of conditions is the next largest factor
in scoring. Files with more conditions will always be favored. Any
invalid condition will disqualify that file completely.
in scoring. Files with more conditions will always be favored. Any in‐
valid condition will disqualify that file completely.
If you don't care to have all versions of alternates stored in the same
directory as the generated symlink, you can place them in the
$HOME/.config/yadm/alt directory. The generated symlink or processed
template will be created using the same relative path.
Alternate linking may best be demonstrated by example. Assume the fol-
Alternate linking may best be demonstrated by example. Assume the fol‐
lowing files are managed by yadm's repository:
- $HOME/path/example.txt##default
@ -462,7 +461,7 @@
If running on a Macbook named "host2", yadm will create a symbolic link
which looks like this:
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin,host-
$HOME/path/example.txt -> $HOME/path/example.txt##os.Darwin,host‐
name.host2
However, on another Mackbook named "host3", yadm will create a symbolic
@ -491,7 +490,7 @@
Links are also created for directories named this way, as long as they
have at least one yadm managed file within them (at the top level).
yadm will automatically create these links by default. This can be dis-
yadm will automatically create these links by default. This can be dis‐
abled using the yadm.auto-alt configuration. Even if disabled, links
can be manually created by running yadm alt.
@ -504,8 +503,8 @@
yadm config local.class Work
Similarly, the values of architecture, os, hostname, and user can be
manually overridden using the configuration options local.arch,
local.os, local.hostname, and local.user.
manually overridden using the configuration options local.arch, lo‐
cal.os, local.hostname, and local.user.
## TEMPLATES
@ -517,7 +516,7 @@
default
This is yadm's built-in template processor. This processor is
very basic, with a Jinja-like syntax. The advantage of this pro-
very basic, with a Jinja-like syntax. The advantage of this pro‐
cessor is that it only depends upon awk, which is available on
most *nix systems. To use this processor, specify the value of
"default" or just leave the value off (e.g. "##template").
@ -537,14 +536,13 @@
envtpl To use the envtpl Jinja template processor, specify the value of
"j2" or "envtpl".
NOTE: Specifying "j2" as the processor will attempt to use j2cli or
envtpl, whichever is available.
NOTE: Specifying "j2" as the processor will attempt to use j2cli or en‐
vtpl, whichever is available.
If the template processor specified is available, templates will be
processed to create or overwrite files.
During processing, the following variables are available in the tem-
During processing, the following variables are available in the tem‐
plate:
Default Jinja or ESH Description
@ -635,7 +633,7 @@
The yadm encrypt command will find all files matching the patterns, and
prompt for a password. Once a password has confirmed, the matching
files will be encrypted and saved as $HOME/.local/share/yadm/archive.
The "encrypt" and "archive" files should be added to the yadm reposi-
The "encrypt" and "archive" files should be added to the yadm reposi‐
tory so they are available across multiple systems.
To decrypt these files later, or on another system run yadm decrypt and
@ -650,14 +648,14 @@
Patterns found in $HOME/.config/yadm/encrypt are automatically added to
the repository's info/exclude file every time yadm encrypt is run.
This is to prevent accidentally committing sensitive data to the repos-
This is to prevent accidentally committing sensitive data to the repos‐
itory. This can be disabled using the yadm.auto-exclude configuration.
Using transcrypt or git-crypt
A completely separate option for encrypting data is to install and use
transcrypt or git-crypt. Once installed, you can use these tools by
running yadm transcrypt or yadm git-crypt. These tools enables trans-
running yadm transcrypt or yadm git-crypt. These tools enables trans‐
parent encryption and decryption of files in a git repository. See the
following web sites for more information:
@ -665,10 +663,8 @@
- https://github.com/AGWA/git-crypt
## PERMISSIONS
When files are checked out of a Git repository, their initial permis-
When files are checked out of a Git repository, their initial permis‐
sions are dependent upon the user's umask. Because of this, yadm will
automatically update the permissions of some file paths. The "group"
and "others" permissions will be removed from the following files:
@ -681,11 +677,11 @@
- The GPG directory and files, .gnupg/*
yadm will automatically update permissions by default. This can be dis-
abled using the yadm.auto-perms configuration. Even if disabled, per-
missions can be manually updated by running yadm perms. The .ssh
directory processing can be disabled using the yadm.ssh-perms configu-
ration. The .gnupg directory processing can be disabled using the
yadm will automatically update permissions by default. This can be dis‐
abled using the yadm.auto-perms configuration. Even if disabled, per‐
missions can be manually updated by running yadm perms. The .ssh di‐
rectory processing can be disabled using the yadm.ssh-perms configura‐
tion. The .gnupg directory processing can be disabled using the
yadm.gpg-perms configuration.
When cloning a repo which includes data in a .ssh or .gnupg directory,
@ -695,18 +691,18 @@
When running a Git command and .ssh or .gnupg directories do not exist,
yadm will create those directories with mask 0700 prior to running the
Git command. This can be disabled using the yadm.auto-private-dirs con-
Git command. This can be disabled using the yadm.auto-private-dirs con‐
figuration.
## HOOKS
For every command yadm supports, a program can be provided to run
before or after that command. These are referred to as "hooks". yadm
For every command yadm supports, a program can be provided to run be‐
fore or after that command. These are referred to as "hooks". yadm
looks for hooks in the directory $HOME/.config/yadm/hooks. Each hook
is named using a prefix of pre_ or post_, followed by the command which
should trigger the hook. For example, to create a hook which is run
after every yadm pull command, create a hook named post_pull. Hooks
must have the executable file permission set.
should trigger the hook. For example, to create a hook which is run af‐
ter every yadm pull command, create a hook named post_pull. Hooks must
have the executable file permission set.
If a pre_ hook is defined, and the hook terminates with a non-zero exit
status, yadm will refuse to run the yadm command. For example, if a
@ -737,15 +733,15 @@
## FILES
All of yadm's configurations are relative to the "yadm directory".
yadm uses the "XDG Base Directory Specification" to determine this
directory. If the environment variable $XDG_CONFIG_HOME is defined as
a fully qualified path, this directory will be $XDG_CONFIG_HOME/yadm.
yadm uses the "XDG Base Directory Specification" to determine this di‐
rectory. If the environment variable $XDG_CONFIG_HOME is defined as a
fully qualified path, this directory will be $XDG_CONFIG_HOME/yadm.
Otherwise it will be $HOME/.config/yadm.
Similarly, yadm's data files are relative to the "yadm data directory".
yadm uses the "XDG Base Directory Specification" to determine this
directory. If the environment variable $XDG_DATA_HOME is defined as a
fully qualified path, this directory will be $XDG_DATA_HOME/yadm. Oth-
yadm uses the "XDG Base Directory Specification" to determine this di‐
rectory. If the environment variable $XDG_DATA_HOME is defined as a
fully qualified path, this directory will be $XDG_DATA_HOME/yadm. Oth‐
erwise it will be $HOME/.local/share/yadm.
The following are the default paths yadm uses for its own data. Most
@ -753,7 +749,7 @@
section for details.
$HOME/.config/yadm
The yadm directory. By default, all configs yadm stores is rela-
The yadm directory. By default, all configs yadm stores is rela‐
tive to this directory.
$HOME/.local/share/yadm
@ -765,7 +761,7 @@
$YADM_DIR/alt
This is a directory to keep "alternate files" without having
them side-by-side with the resulting symlink or processed tem-
them side-by-side with the resulting symlink or processed tem‐
plate. Alternate files placed in this directory will be created
relative to $HOME instead.

2
yadm.spec
View file

@ -1,7 +1,7 @@
%{!?_pkgdocdir: %global _pkgdocdir %{_docdir}/%{name}-%{version}}
Name: yadm
Summary: Yet Another Dotfiles Manager
Version: 3.2.1
Version: 3.2.2
Group: Development/Tools
Release: 1%{?dist}
URL: https://yadm.io