Search icon CANCEL
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Conferences
Free Learning
Arrow right icon
Gitlab Cookbook
Gitlab Cookbook

Gitlab Cookbook: Over 60 hands-on recipes to efficiently self-host your own Git repository using GitLab

eBook
$13.98 $19.99
Paperback
$32.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Table of content icon View table of contents Preview book icon Preview Book

Gitlab Cookbook

Chapter 2. Explaining Git

In this chapter, we will cover the following recipes:

  • Generating your SSH key on Unix-like systems
  • Generating your SSH key on Windows
  • Adding your SSH key to GitLab
  • Creating your first Git project
  • Cloning your repository and pushing code to it
  • Working with branches
  • Performing a rebase
  • Squashing your commits

Introduction

Before you can use GitLab, you need to know a little about Git itself, what Git is, and what pushing code is. As Git is a very complex system and is worthy of a book of its own, I'm just going to cover the basics. You'll learn how to get your SSH key and how to push your first code to GitLab.

Git is in the heart of GitLab. Without it, there would be no GitLab. It is a super powerful source control system, and has some amazing features. We will take a look at some of those feature in this chapter.

In this chapter, I'll assume that you will be using Git over SSH. However, most recipes will work even if you use Git over HTTP.

If you want to learn more about Git, I recommend that you follow the try.github.io course. It's a free online workshop, and you will learn everything related to Git in an interactive way.

Generating your SSH key on Unix-like systems

Generating an SSH key on Linux and OS X is easy; they come with a built-in tool to do this, called ssh-keygen.

How to do it…

In the following steps, we will create an SSH key for your Unix system:

  1. First, we are going to check whether you have any SSH keys present. Open your terminal and enter the following command:
    $ ls ~/.ssh
    
  2. If you have a file named id_rsa.pub or id_dsa.pub, you can skip this recipe.
  3. To generate a new SSH key, you need to open your terminal and enter the following command:
    $ ssh-keygen -t rsa -C "Comment for key"
    

    The comment can be anything you want; it makes it easier for you to see which key it is when you open the key file.

  4. Now, we get to the question of what you want to name your key. Just press Enter.
  5. You will be asked to enter a passphrase. Enter it, and be sure to choose a strong password.

    You should see the following screenshot:

    How to do it…

Your SSH key is now generated.

How it works…

We just created our personal SSH...

Generating your SSH key on Windows

As Windows does not have a fully functioning terminal, we have to take some other steps to install Git and generate our SSH key. We will take a look at how this is done in this recipe.

How to do it…

  1. Go to http://git-scm.com/downloads and click on Windows.
    How to do it…
  2. The download will start automatically. When it's done, you see the following installation window:
    How to do it…
  3. Click on Next and accept the license agreement.
  4. Choose where you want to install Git and click on Next.
  5. You will want the following components to be selected:
    • Windows Explorer integration
    • Associate .git* configuration files with the default text editor
    • Associate .sh files to be run with Bash

    After selecting the preceding components, click on Next. The following screenshot shows you these options:

    How to do it…
  6. Choose where you want to place Git in your start menu and click on Next.
  7. Choose Use Git from Git Bash only and click on Next.
    How to do it…
  8. Select Checkout Windows-style, commit Unix-style line endings, and click on Next.
    How to do it…
  9. Wait until...

Adding your SSH key to GitLab

In order for GitLab to know who we are and check whether we are authorized to commit certain code, we use our SSH key. The combination of the public key and the private key can tell GitLab that we are authorized, and GitLab will allow the operation to be performed.

How to do it…

To set up your SSH key, perform the following steps:

  1. Open GitLab and go to your account settings.
    How to do it…
  2. Click on SSH.
  3. Click on Add SSH Key.
    How to do it…
  4. To get information about your SSH key, enter the following command in your terminal. If you're using Windows, go to step 7:
    $ cat ~/.ssh/id_rsa.pub
    
  5. You should copy the entire content of the output in step 4, as shown in the following screenshot:
    How to do it…
  6. If you're not using Windows, you can move to step 11.
  7. Open the Windows explorer and move to C:\Users\your_username\.ssh.
  8. Right-click on id_rsa.pub and click on Open.
  9. When asked for the program you want to use, select Notepad.
  10. Select the entire content of the file that contains the SSH key.
    How to do it…
  11. We now paste the...

Creating your first Git project

In this recipe, we will take a look at creating your first Git project on your local machine. If you're a Windows user, please make sure that you use Git Bash. This way, you can use the same commands as the ones Linux and OS X users use.

We're going to create a project called super-git.

How to do it…

To create our first Git project, perform the following steps:

  1. Open your terminal and browse to the folder where you want to create your project.
  2. Create a folder named super-git and create the following directory inside it:
    $ mkdir super-git
    $ cd super-git
    
  3. To make this folder a Git project, we need to tell Git to monitor this folder. We do this by typing the following command:
    $ git init
    

    The following screenshot shows you the output for this command:

    How to do it…
  4. Let's create one file to add to the repository. We name it README.md:
    $ echo "HELLO README" > README.md	
    
  5. Now, we will add this new file to Git. This is also known as staging the files:
    $ git...

Cloning your repository and pushing code to it

In this recipe, we will take a look at cloning your repository from GitLab to your local machine. When you use Git Bash on Windows, the commands will be the same.

Getting ready

You need to create a new repository in your GitLab instance. In this example, we will use the repository named super-git.

How to do it…

In the following steps, we will set up our repository and push code to it:

  1. Go to the newly created repository.
  2. Select the URL in the top-right section.
    How to do it…
  3. Go to the folder where you want to check out the project in the terminal. No need to create a new folder for the project.
  4. Enter the Git clone command, and change the URL to the URL you just copied:
    $ git clone URL
    

    In my case, the URL is as follows:

    $ git clone git@146.185.139.107:jeroen/super-git.git
    

    The following screenshot shows you the output of this command:

    How to do it…
  5. You can now go to the folder and check whether it is a Git folder by running the following command:
    $ git status
    

    The following screenshot...

Introduction


Before you can use GitLab, you need to know a little about Git itself, what Git is, and what pushing code is. As Git is a very complex system and is worthy of a book of its own, I'm just going to cover the basics. You'll learn how to get your SSH key and how to push your first code to GitLab.

Git is in the heart of GitLab. Without it, there would be no GitLab. It is a super powerful source control system, and has some amazing features. We will take a look at some of those feature in this chapter.

In this chapter, I'll assume that you will be using Git over SSH. However, most recipes will work even if you use Git over HTTP.

If you want to learn more about Git, I recommend that you follow the try.github.io course. It's a free online workshop, and you will learn everything related to Git in an interactive way.

Generating your SSH key on Unix-like systems


Generating an SSH key on Linux and OS X is easy; they come with a built-in tool to do this, called ssh-keygen.

How to do it…

In the following steps, we will create an SSH key for your Unix system:

  1. First, we are going to check whether you have any SSH keys present. Open your terminal and enter the following command:

    $ ls ~/.ssh
    
  2. If you have a file named id_rsa.pub or id_dsa.pub, you can skip this recipe.

  3. To generate a new SSH key, you need to open your terminal and enter the following command:

    $ ssh-keygen -t rsa -C "Comment for key"
    

    The comment can be anything you want; it makes it easier for you to see which key it is when you open the key file.

  4. Now, we get to the question of what you want to name your key. Just press Enter.

  5. You will be asked to enter a passphrase. Enter it, and be sure to choose a strong password.

    You should see the following screenshot:

Your SSH key is now generated.

How it works…

We just created our personal SSH key: one key is the id_rsa...

Generating your SSH key on Windows


As Windows does not have a fully functioning terminal, we have to take some other steps to install Git and generate our SSH key. We will take a look at how this is done in this recipe.

How to do it…

  1. Go to http://git-scm.com/downloads and click on Windows.

  2. The download will start automatically. When it's done, you see the following installation window:

  3. Click on Next and accept the license agreement.

  4. Choose where you want to install Git and click on Next.

  5. You will want the following components to be selected:

    • Windows Explorer integration

    • Associate .git* configuration files with the default text editor

    • Associate .sh files to be run with Bash

    After selecting the preceding components, click on Next. The following screenshot shows you these options:

  6. Choose where you want to place Git in your start menu and click on Next.

  7. Choose Use Git from Git Bash only and click on Next.

  8. Select Checkout Windows-style, commit Unix-style line endings, and click on Next.

  9. Wait until the...

Left arrow icon Right arrow icon

Description

This book is aimed at developers and devops that have a GitLab server running, and want to be sure they use it to its full potential. This book will also be useful for people looking for a great Git platform, and learn how to set it up successfully. Some system administrating experience on a UNIX-based system would be useful, but is not required.

What you will learn

  • Install and maintain your GitLab instance
  • Work with multiple users, create groups, and configure your project visibility
  • Secure your code with the correct GitLab configuration
  • Make the most of the builtin issue tracker, including merge requests
  • Manage your projects through the GitLab API
  • Set up webhooks and system hooks to receive notifications
  • Manage your GitLab server using LDAP
Estimated delivery fee Deliver to Japan

Standard delivery 10 - 13 business days

$8.95

Premium delivery 3 - 6 business days

$34.95
(Includes tracking information)

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Dec 24, 2014
Length: 172 pages
Edition : 1st
Language : English
ISBN-13 : 9781783986842

What do you get with Print?

Product feature icon Instant access to your digital eBook copy whilst your Print order is Shipped
Product feature icon Paperback book shipped to your preferred address
Product feature icon Download this book in EPUB and PDF formats
Product feature icon Access this title in our online reader with advanced features
Product feature icon DRM FREE - Read whenever, wherever and however you want
Estimated delivery fee Deliver to Japan

Standard delivery 10 - 13 business days

$8.95

Premium delivery 3 - 6 business days

$34.95
(Includes tracking information)

Product Details

Publication date : Dec 24, 2014
Length: 172 pages
Edition : 1st
Language : English
ISBN-13 : 9781783986842

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 89.97
Gitlab Cookbook
$32.99
Git Best Practices Guide
$29.99
Git Essentials
$26.99
Total $ 89.97 Stars icon

Table of Contents

10 Chapters
1. Introduction and Installation Chevron down icon Chevron up icon
2. Explaining Git Chevron down icon Chevron up icon
3. Managing Users, Groups, and Permissions Chevron down icon Chevron up icon
4. Issue Tracker and Wiki Chevron down icon Chevron up icon
5. Maintaining Your GitLab Instance Chevron down icon Chevron up icon
6. Webhooks, External Services, and the API Chevron down icon Chevron up icon
7. Using LDAP and OmniAuth Providers Chevron down icon Chevron up icon
8. GitLab CI Chevron down icon Chevron up icon
A. Tips and Tricks Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Rating distribution
Full star icon Full star icon Full star icon Half star icon Empty star icon 3.3
(3 Ratings)
5 star 33.3%
4 star 33.3%
3 star 0%
2 star 0%
1 star 33.3%
dblessing Feb 24, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
This book covers all the details needed to get up and running with git and GitLab. Jeroen does a great job with tough topics for beginners in his introduction to git, installation of GitLab from source and the new Omnibus packages, basic troubleshooting and managing upgrades. This book also provides in-depth coverage of all the GitLab features, GitLab Continuous Integration server (GitLab CI), the GitLab API, and more. I was pleasantly surprised to see the section dedicated to LDAP integration, too. Overall, this book provides a good foundation for GitLab users.
Amazon Verified review Amazon
Erich S. Mar 08, 2016
Full star icon Full star icon Full star icon Full star icon Empty star icon 4
Dieses Buch liefert in kurzen und verständlichen Beispielen die Grundzüge von GitLab. Da ich selbst von der Gerrit-Welt komme ist GitLab für mich ein weiter Sprung Richtung Development Zukunft.Schmerzlich vermisse ich jedoch Beispiele für die Anbindung an externe Systeme wie JIRA & Jenkins, welche jedoch State of the Art für Developers & DevOps sind.
Amazon Verified review Amazon
John Pitton Sep 05, 2016
Full star icon Empty star icon Empty star icon Empty star icon Empty star icon 1
A lot of the material is outdated. Almost all of what this book covers is listed for free at gitlabdotcomslashhelp. It would be awesome if the book was periodically updated biannually.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is the delivery time and cost of print book? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela
What is custom duty/charge? Chevron down icon Chevron up icon

Customs duty are charges levied on goods when they cross international borders. It is a tax that is imposed on imported goods. These duties are charged by special authorities and bodies created by local governments and are meant to protect local industries, economies, and businesses.

Do I have to pay customs charges for the print book order? Chevron down icon Chevron up icon

The orders shipped to the countries that are listed under EU27 will not bear custom charges. They are paid by Packt as part of the order.

List of EU27 countries: www.gov.uk/eu-eea:

A custom duty or localized taxes may be applicable on the shipment and would be charged by the recipient country outside of the EU27 which should be paid by the customer and these duties are not included in the shipping charges been charged on the order.

How do I know my custom duty charges? Chevron down icon Chevron up icon

The amount of duty payable varies greatly depending on the imported goods, the country of origin and several other factors like the total invoice amount or dimensions like weight, and other such criteria applicable in your country.

For example:

  • If you live in Mexico, and the declared value of your ordered items is over $ 50, for you to receive a package, you will have to pay additional import tax of 19% which will be $ 9.50 to the courier service.
  • Whereas if you live in Turkey, and the declared value of your ordered items is over € 22, for you to receive a package, you will have to pay additional import tax of 18% which will be € 3.96 to the courier service.
How can I cancel my order? Chevron down icon Chevron up icon

Cancellation Policy for Published Printed Books:

You can cancel any order within 1 hour of placing the order. Simply contact customercare@packt.com with your order details or payment transaction id. If your order has already started the shipment process, we will do our best to stop it. However, if it is already on the way to you then when you receive it, you can contact us at customercare@packt.com using the returns and refund process.

Please understand that Packt Publishing cannot provide refunds or cancel any order except for the cases described in our Return Policy (i.e. Packt Publishing agrees to replace your printed book because it arrives damaged or material defect in book), Packt Publishing will not accept returns.

What is your returns and refunds policy? Chevron down icon Chevron up icon

Return Policy:

We want you to be happy with your purchase from Packtpub.com. We will not hassle you with returning print books to us. If the print book you receive from us is incorrect, damaged, doesn't work or is unacceptably late, please contact Customer Relations Team on customercare@packt.com with the order number and issue details as explained below:

  1. If you ordered (eBook, Video or Print Book) incorrectly or accidentally, please contact Customer Relations Team on customercare@packt.com within one hour of placing the order and we will replace/refund you the item cost.
  2. Sadly, if your eBook or Video file is faulty or a fault occurs during the eBook or Video being made available to you, i.e. during download then you should contact Customer Relations Team within 14 days of purchase on customercare@packt.com who will be able to resolve this issue for you.
  3. You will have a choice of replacement or refund of the problem items.(damaged, defective or incorrect)
  4. Once Customer Care Team confirms that you will be refunded, you should receive the refund within 10 to 12 working days.
  5. If you are only requesting a refund of one book from a multiple order, then we will refund you the appropriate single item.
  6. Where the items were shipped under a free shipping offer, there will be no shipping costs to refund.

On the off chance your printed book arrives damaged, with book material defect, contact our Customer Relation Team on customercare@packt.com within 14 days of receipt of the book with appropriate evidence of damage and we will work with you to secure a replacement copy, if necessary. Please note that each printed book you order from us is individually made by Packt's professional book-printing partner which is on a print-on-demand basis.

What tax is charged? Chevron down icon Chevron up icon

Currently, no tax is charged on the purchase of any print book (subject to change based on the laws and regulations). A localized VAT fee is charged only to our European and UK customers on eBooks, Video and subscriptions that they buy. GST is charged to Indian customers for eBooks and video purchases.

What payment methods can I use? Chevron down icon Chevron up icon

You can pay with the following card types:

  1. Visa Debit
  2. Visa Credit
  3. MasterCard
  4. PayPal
What is the delivery time and cost of print books? Chevron down icon Chevron up icon

Shipping Details

USA:

'

Economy: Delivery to most addresses in the US within 10-15 business days

Premium: Trackable Delivery to most addresses in the US within 3-8 business days

UK:

Economy: Delivery to most addresses in the U.K. within 7-9 business days.
Shipments are not trackable

Premium: Trackable delivery to most addresses in the U.K. within 3-4 business days!
Add one extra business day for deliveries to Northern Ireland and Scottish Highlands and islands

EU:

Premium: Trackable delivery to most EU destinations within 4-9 business days.

Australia:

Economy: Can deliver to P. O. Boxes and private residences.
Trackable service with delivery to addresses in Australia only.
Delivery time ranges from 7-9 business days for VIC and 8-10 business days for Interstate metro
Delivery time is up to 15 business days for remote areas of WA, NT & QLD.

Premium: Delivery to addresses in Australia only
Trackable delivery to most P. O. Boxes and private residences in Australia within 4-5 days based on the distance to a destination following dispatch.

India:

Premium: Delivery to most Indian addresses within 5-6 business days

Rest of the World:

Premium: Countries in the American continent: Trackable delivery to most countries within 4-7 business days

Asia:

Premium: Delivery to most Asian addresses within 5-9 business days

Disclaimer:
All orders received before 5 PM U.K time would start printing from the next business day. So the estimated delivery times start from the next day as well. Orders received after 5 PM U.K time (in our internal systems) on a business day or anytime on the weekend will begin printing the second to next business day. For example, an order placed at 11 AM today will begin printing tomorrow, whereas an order placed at 9 PM tonight will begin printing the day after tomorrow.


Unfortunately, due to several restrictions, we are unable to ship to the following countries:

  1. Afghanistan
  2. American Samoa
  3. Belarus
  4. Brunei Darussalam
  5. Central African Republic
  6. The Democratic Republic of Congo
  7. Eritrea
  8. Guinea-bissau
  9. Iran
  10. Lebanon
  11. Libiya Arab Jamahriya
  12. Somalia
  13. Sudan
  14. Russian Federation
  15. Syrian Arab Republic
  16. Ukraine
  17. Venezuela