DeskTux

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== git ======
A (very) basic [[https://git-scm.com/|git]] server and repository can be handy for a couple of reasons. I personally use it for [[:apps:puppet|Puppet]] code and some scripting.

===== Installation & Configuration =====
To install git, just run a basic ''apt install git'' and you are good to go. No configuration needed.

===== Set up a repository =====
  - Create a directory for your repositories, e.g. ''/srv/git'' and make sure your git users will be able to write into it. There are basically two approaches to accomplish that, one is to create a 'git' user who will receive the public SSH key of all your users and will be used by all of them and the other is to create a 'git' group that will grant write access to that directory. Preferably you should use ACL's for that to make sure local changes or umasks cannot get into your way, but that is of course completely up to you.
  - Next, create a project directory. I will use [[:apps:puppet|Puppet]] as an example here, so create a directory for that: <code>mkdir -p /srv/git/puppet.git</code>
  - Change to that directory and initialize your git repository: <code>cd /srv/git/puppet.git; git init</code>
  - Give your project a meaningful description:((Use your preferred editor, I just like vi)) <code>vi .git/description</code>
  - Configure the basics of the git client:<code>
git config --global user.name "Your Name"
git config --global user.email you@example.com
git config --global credential.helper store
git config --global push.default simple
git config --global color.ui true</code>
  - Create a README and make the initial commit: <code>touch README.md; git add .; git commit -m "Initialize Repository"</code>

Now you are good to go to use this repo from a remote computer that has SSH access to this system.

===== Usage from a client =====
==== One time only steps on the client ====
  - First, install git on your client as well: <code>apt install git</code>
  - Make the basic configuration to also set your name and e-mail address (see above, "Configure the basics of the git client").
  - Clone the Repository: <code>git clone ssh://user@server.tld/srv/git/puppet.git</code>
  - Switch to the newly created directory containing the project data: <code>cd puppet</code>

==== Client steps for every change ====
  - Update the local repository: <code>git pull</code>
  - Create a new branch: <code>git checkout -b mybranch</code>
  - Make your changes, creating and editing files, creating directories.
  - Parse and lint your code.
  - Add your changes to git (do this from the top directory, or add all files/directories individually): <code>git add .</code>
  - Commit your changes and supply a meaningful commit message: <code>git commit -m "My meaningful change description"</code>
  - Upload the changes to a new branch in the git server: <code>git push -u origin mybranch</code>

==== Server steps for every change ====
  - Log in to your server as either root or git user (depending on the setup you chose above)
  - Switch to the project directory: <code>cd /srv/git/puppet.git</code>
  - Show all branches: <code>git branch</code>
  - Identify the branch you want to merge into the master branch and merge it: <code>git merge mybranch</code>
  - Delete that branch: <code>git branch -D mybranch</code>

==== Final steps on the client (clean up) ====
  - Switch back to the master branch: <code>git checkout master</code>
  - Delete your development branch: <code>git branch -D mybranch</code>
  - Update all local data: <code>git pull; git fetch --prune</code>

===== Troubleshooting/Q&A =====
  * If you ever wonder what branch you are on, you can just run a ''git status'' to check that, or just use my [[:apps:zsh|ZSH]] configuration which will show the current branch.
  * If you use this for [[:apps:puppet|Puppet]] code, you could just create a symlink from the Puppet code directory to your git project:((Providing you used the same structure as mandatory in the [[:apps:puppet#manifests|Puppet]] code directory. Don't forget to backup first!)) <code>ln -sf /srv/git/puppet.git /etc/puppet/code</code>
  * In case you forgot to delete your branch on the server, or want to just delete it remotely, you can do that: <code>git push -u origin mybranch --delete</code>
  * If you already started editing but forgot to switch to a new development branch, in many cases it is still possible to just switch to a new branch after you made changes already and just follow the workflow.
  * In case the local (master) branch is no longer usable, use these steps to reset it: <code>
git fetch origin master
git reset --hard FETCH_HEAD
git clean -df</code>
====== What next? ======
Actually, stuff like parsing & linting, merging on the server and deploying your code where it belongs (e.g. Puppet) should be automated. A basic git setup like this doesn't allow for this, unless you throw some serious scripting at it. If you want pipelines and e.g. [[https://jenkins.io/|Jenkins]], you need tools like [[https://github.com/|GitHub]].

Unfortunately, they do not offer an open-source version of their software, just hosted by them or in an Enterprise Edition. Luckily, there is [[https://about.gitlab.com/|GitLab]] that provides all of this functionality. And: it will run on Debian :-) So if you want or need pipelines and user/privilege management etc, you should check out GitLab.