Release 2.3.0

Update version number and update documentation

* Support git-crypt (#168)
* Support specifying a command after `yadm enter`
* Expose GIT_WORK_TREE during `yadm enter` (#160)
* Support GNUPGHOME environment variable (#134)
* Assert private dirs, only when worktree = $HOME (#171)

CHANGES

@@ -1,3 +1,10 @@
+2.3.0
+  * Support git-crypt (#168)
+  * Support specifying a command after `yadm enter`
+  * Expose GIT_WORK_TREE during `yadm enter` (#160)
+  * Support GNUPGHOME environment variable (#134)
+  * Assert private dirs, only when worktree = $HOME (#171)
+
 2.2.0
   * Resolve hostname using `uname -n` (#182)
   * Use /etc/os-release if lsb_release is missing (#175)

README.md

@@ -42,7 +42,7 @@ Features, usage, examples and installation instructions can be found on the
 [master-badge]: https://img.shields.io/travis/TheLocehiliosan/yadm/master.svg?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-v2.2.0-blue
+[obs-badge]: https://img.shields.io/badge/OBS-v2.3.0-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

yadm

@@ -20,7 +20,7 @@ if [ -z "$BASH_VERSION" ]; then
   [ "$YADM_TEST" != 1 ] && exec bash "$0" "$@"
 fi
 
-VERSION=2.2.0
+VERSION=2.3.0
 
 YADM_WORK="$HOME"
 YADM_DIR=

yadm.1

@@ -1,5 +1,5 @@
 ." vim: set spell so=8:
-.TH yadm 1 "6 December 2019" "2.2.0"
+.TH yadm 1 "17 December 2019" "2.3.0"
 
 .SH NAME
 

yadm.md

@@ -24,14 +24,16 @@
 
        yadm encrypt
 
-       yadm enter
-
        yadm decrypt [-l]
 
        yadm alt
 
        yadm perms
 
+       yadm enter [ command ]
+
+       yadm git-crypt [ options ]
+
        yadm upgrade
 
        yadm introspect category
@@ -116,10 +118,15 @@
               the same way you leave  your  normal  shell  (usually  with  the
               "exit"  command).  This sub-shell can be used to easily interact
               with your yadm repository using "git" commands.  This  could  be
-              useful if you are using a tool which uses Git directly.
+              useful  if you are using a tool which uses Git directly, such as
+              tig, vim-fugitive, git-cola, etc.
 
-              For  example,  Emacs  Tramp  and Magit can manage files by using
-              this configuration:
+              Optionally, you can provide a command after "enter", and instead
+              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-
+              tion:
 
                   (add-to-list 'tramp-methods
                        '("yadm"
@@ -133,6 +140,15 @@
               issue with Emacs 27 and  zsh,  trying  running  (setenv  "SHELL"
               "/bin/bash").
 
+       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.
+
+              git-crypt enables transparent encryption and decryption of files
+              in a git repository.  You can read  https://github.com/AGWA/git-
+              crypt for details.
+
        gitconfig
               Pass  options to the git config command. Since yadm already uses
               the config command to manage its own configurations,  this  com-
@@ -581,6 +597,15 @@
        This is to prevent accidentally committing sensitive data to the repos-
        itory.  This can be disabled using the yadm.auto-exclude configuration.
 
+       Using git-crypt
+
+       A  completely separate option for encrypting data is to install and use
+       git-crypt.  Once installed, you can run git-crypt commands for the yadm
+       repo  by running yadm git-crypt.  git-crypt enables transparent encryp-
+       tion and decryption of  files  in  a  git  repository.   You  can  read
+       https://github.com/AGWA/git-crypt for details.
+
+
 
 ## PERMISSIONS
        When  files  are checked out of a Git repository, their initial permis-

yadm.spec

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