mirrors/dotdrop
1
0
Fork 0
mirror of https://github.com/deadc0de6/dotdrop.git synced 2026-02-05 01:34:42 +00:00
Code Activity

Update README.md

Browse Source
This commit is contained in:
deadc0de
2018-02-07 17:08:38 +01:00
committed by GitHub
parent 047ab1bd92
commit 298c6a549e
1 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -323,17 +323,18 @@ be executed.
## Use transformations
Transformation actions are used to transform a dotfile before it is
installed. They work like [actions](#use-actions) but have two arguments:
installed. They work like [actions](#use-actions) but are executed before the
dotfile is installed to transform the source.
Transformation commands have two arguments:
* **{0}** will be replaced with the dotfile to process
* **{1}** will be replaced with a temporary file to store the result
* **{1}** will be replaced with a temporary file to store the result of the transformation
A typical use-case for transformations is when the dotfile needs to be
stored encrypted.
For example:
the transformation and the dotfile in `config.yaml`:
Here's an example of part of a config file to use gpg encrypted dotfiles:
```
dotfiles:
f_secret:
@@ -348,6 +349,23 @@ trans:
The above config allows to store the dotfile `~/.secret` encrypted in the *dotfiles*
directory and uses gpg to decrypt it when install is run.
Here's how to deploy the above solution:
* import the clear dotfile (creates the entries in the config)
```
./dotdrop.sh import ~/.secret
```
* encrypt it and
```
<some-gpg-command> ~/.secret
```
* overwrite the dotfile
```
cp <encrypted-version-of-secret> dotfiles/secret
```
* edit the config file and add the transformation to the dotfile
* commit and push changes
## Update dotdrop
If used as a submodule, update it with