templis
/
dotconfs
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

„README.md“ ändern

This commit is contained in:
templis 2021-01-08 02:45:55 +01:00
parent 9f06dffab3
commit 784bb7ac3c
1 changed files with 3 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

91
README.md
View File

@ -24,9 +24,9 @@ Then we create an alias config which we will use instead of the regular git when
We set a flag - local to the repository - to hide files we are not explicitly tracking yet. This is so that when you type config status and other commands later, files you are not interested in tracking will not show up as untracked.
Also you can add the alias definition by hand to your .bashrc or .zshrc or use the the fourth line provided for convenience.
I packaged the above lines into a snippet up on Bitbucket and linked it from a short-url. So that you can set things up with:
I packaged the above lines into a snippet up. So that you can set things up with:
`curl -Lks http://bit.do/cfg-init | /bin/bash`
`curl -Lks https://git.shron.de/templis/dotconfs/src/branch/master/.scripts/install.sh | /bin/bash`
After you've executed the setup any file within the $HOME folder can be versioned with normal commands, replacing git with your newly created config alias, like:
@ -41,89 +41,4 @@ config commit -m "Add bashrc"
config push
```
Install your dotfiles onto a new system (or migrate to this setup)
If you already store your configuration/dotfiles in a Git repository, on a new system you can migrate to this setup with the following steps:
* Prior to the installation make sure you have committed the alias to your .bashrc or .zsh:
`alias config='/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME'`
* And that your source repository ignores the folder where you'll clone it, so that you don't create weird recursion problems:
`echo ".cfg" >> .gitignore`
* Now clone your dotfiles into a bare repository in a "dot" folder of your $HOME:
`git clone --bare <git-repo-url> $HOME/.cfg`
* Define the alias in the current shell scope:
`alias config='/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME'`
* Checkout the actual content from the bare repository to your $HOME:
`config checkout`
* The step above might fail with a message like:
> error: The following untracked working tree files would be overwritten by checkout:
> .bashrc
> .gitignore
> Please move or remove them before you can switch branches.
> Aborting
This is because your $HOME folder might already have some stock configuration files which would be overwritten by Git. The solution is simple: back up the files if you care about them, remove them if you don't care. I provide you with a possible rough shortcut to move all the offending files automatically to a backup folder:
```
mkdir -p .config-backup && \
config checkout 2>&1 | egrep "\s+\." | awk {'print $1'} | \
xargs -I{} mv {} .config-backup/{}
```
* Re-run the check out if you had problems:
config checkout
* Set the flag showUntrackedFiles to no on this specific (local) repository:
`config config --local status.showUntrackedFiles no`
* You're done, from now on you can now type config commands to add and update your dotfiles:
```
config status
config add .vimrc
config commit -m "Add vimrc"
config add .bashrc
config commit -m "Add bashrc"
config push
```
Again as a shortcut not to have to remember all these steps on any new machine you want to setup, you can create a simple script, store it as Bitbucket snippet like I did, create a short url for it and call it like this:
`curl -Lks http://bit.do/cfg-install | /bin/bash`
For completeness this is what I ended up with (tested on many freshly minted Alpine Linux containers to test it out):
```
git clone --bare https://bitbucket.org/durdn/cfg.git $HOME/.cfg
function config {
/usr/bin/git --git-dir=$HOME/.cfg/ --work-tree=$HOME $@
}
mkdir -p .config-backup
config checkout
if [ $? = 0 ]; then
echo "Checked out config.";
else
echo "Backing up pre-existing dot files.";
config checkout 2>&1 | egrep "\s+\." | awk {'print $1'} | xargs -I{} mv {} .config-backup/{}
fi;
config checkout
config config status.showUntrackedFiles no
```
Wrapping up
I hope you find this technique useful to track your configuration. If you're curious, my dotfiles live here. Also please do stay connected by following @durdn or my awesome team at @atlassiandev.
Install your dotfiles onto a new system (or migrate to this setup)