Engineering-Tech Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== GitLab ======

Since July 2016 we use [[https://gitlab.inf.unibz.it/|GitLab]] to collaborate. 

UNIBZ users have to login to [[https://gitlab.inf.unibz.it/|GitLab]] and their account will be automatically enabled. 

External users can sign up with their Google, Twitter, or Facebook account.

Here are some instructions on GitLab to ease its use.

If you need support on old repositories created via SVN please [[auth:repository_server|continue reading here]].

===== Initial setup =====
Git is usually preinstalled in Linux and Mac, while in Windows you have to [[https://git-scm.com/download/gui/windows | install a client]].

You can have different hosts for different Git repositories which you access via specific username/e-mail. You have to configure your local Git with these settings. 

The steps for pushing and pulling via SSH Key

  * Step 1: [[auth:gitlab#identify_or_create_the_ssh_key|Identify or create SSH Key]] - [[https://docs.gitlab.com/ee/ssh/README.html|Official Documentation]] 
  * Step 2: [[auth:gitlab#add_an_ssh_key|Add SSH Key]] - [[https://docs.gitlab.com/ee/gitlab-basics/create-your-ssh-keys.html|Official Documentation]]
  * Step 3: [[auth:gitlab#configure_your_local_git_client| Configure your local Git client]]

===== Identify or create the SSH key =====
If you need support on how to generate the SSH key follow our guide on [[auth:howto:sshkeygitlab|How to add an SSH Key for GITLAB]]. 

===== Add an SSH key =====
If you already have an SSH key login to GitLab and go to → Profile Settings → SSH Keys. In the field Key copy the contents of the file: id_rsa.pub (or any other file containing your key). 
Once you click Add Key, you will see the it listed.

===== Configure your local Git Client =====

Before proceeding check if your GIT client is already configured. 
LINUX/MACOSX terminal or Windows GIT bash , type the following: <code>git config --global --list</code> <code> git config --list </code>

If you use only one server for Git repositories configure it globally, otherwise locally. 

==== Global GIT configuration ====
To configure GIT globally using the SSH key Inside the terminal/command line, type:
<code>
git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@unibz.it"
git config --list
</code>

This data is stored in your gitconfiguration file: 
Linux/Mac: ~/.gitconfig
Windows: C:\Users\username\.gitconfig

The content should be: 
<code txt>
[user]
        name = Lastname Firstname
        email = your_email@unibz.it
</code>

Add your server data and insert this data in your ssh configuration file. 

Linux/Mac file ~/.ssh/config:
<code>
host gitlab.inf.unibz.it
     user your_username
</code>

Windows file ~/.ssh/config: 
<code>
Host gitlab.inf.unibz.it
RSAAuthentication yes
IdentityFile ~/.ssh/config/id_rsa.pub
</code>

==== Local Configuration ====
You have to run the commands inside the directory where you want your repository to be. From terminal/command line, type:

<code txt>
cd repository_folder
git config user.name "Firstname Lastname"
git config user.email "your_other@email"
</code>

Should you receive this message  **fatal: not in a git directory**, you have to initialize the folder as a git folder. Issue command : <code>
git init
</code> and run commands again.  

===== Basic Git =====
The logic of git requires you to checkout a project via CLONE. You ensure the project files are up to date by issuing a PULL command. Once the modifications on the project are done, you ADD the changes, you COMMIT them and you PUSH them to the gitlab server.

=== Create a new project via the web interface ===
Create a new project via the web interface. 
https://gitlab.inf.unibz.it/projects/new

Send the checkout URL to other collaborators. You can copy/paste it from the project settings (as SSH or as HTTPS).

<note important>When you checkout and you are asked for a password/username it means your configuration has to be edited. Do not insert your username/password. </note>

=== Clone in new folder ===
<code>
git clone git@gitlab.inf.unibz.it:firstname-lastname/my-first-project.git
cd my-first-project
touch README.md
git add README.md
git commit -m "add README"
git push -u origin master

</code>
=== Clone in existing folder ===
<code>
cd existing_folder
git init
git remote add origin git@gitlab.inf.unibz.it:firstname-lastname/my-first-project.git
git add .
git commit
git push -u origin master
</code>

=== Go to the master branch to pull the latest changes from there === 

<code>
git checkout master
</code>

=== Download the latest changes in the project === 

This is for you to work on an up-to-date copy (it is important to do every time you work on a project), while you setup tracking branches.
<code>
git pull REMOTE NAME-OF-BRANCH -u
</code>
(REMOTE: origin) (NAME-OF-BRANCH: could be "master" or an existing branch)
=== Create a branch === 

Spaces won't be recognized, so you need to use a hyphen or underscore.
<code>
git checkout -b NAME-OF-BRANCH
</code>
=== Work on a branch that has already been created === 

<code>
git checkout NAME-OF-BRANCH
</code>
=== View the changes you've made === 

It's important to be aware of what's happening and what's the status of your changes.
<code>
git status
</code>
=== Add changes to commit === 

You'll see your changes in red when you type "git status".
<code>
git add CHANGES IN RED
git commit -m "DESCRIBE THE INTENTION OF THE COMMIT"
</code>

Send changes to gitlab.inf.unibz.it

<code>
git push REMOTE NAME-OF-BRANCH
</code>

An example: <code>
git add .
git commit
git push -u origin master
</code>

=== Delete all changes in the Git repository, but leave unstaged things === 

<code>
git checkout .
</code>

=== Delete all changes in the Git repository, including untracked files === 

<code>
git clean -f
</code>
=== Merge created branch with master branch === 

You need to be in the created branch.
<code>
git checkout NAME-OF-BRANCH
git merge master
</code>


===== Some support cases =====
SourceTree failing to connect

  * Delete entry in keychain for gitlab.inf.unibz.it
  * Add key again to ssh client : ssh-add -K <key_path>


===== Renew the SSL certificates - gitlab.inf.unibz.it =====

Certificate is valid for 3 months

A cronjob renews the certificate every 1st day of the month

  root@gitlab:~# vi /etc/cron.monthly/renew-le-certs

<code>
# At 04:05 on day-of-month 1.
5 4 1 * *       /opt/gitlab/bin/gitlab-ctl renew-le-certs
# At 04:10 on day-of-month 1.
10 4 1 * *      /opt/gitlab/bin/gitlab-ctl reconfigure
</code>