Difference between revisions of "Setting up an Online Repository"

From Frictional Wiki
Jump to navigation Jump to search
(Created page with "{{wip}} This article describes the process of setting up an online Git repository, and discusses the workflow. == Why do I Need a Repository? == The biggest benefit is to co...")
 
m
Line 17: Line 17:
 
# [https://gitlab.com/ Register a free account at GitLab]
 
# [https://gitlab.com/ Register a free account at GitLab]
 
# Before you can properly use the online git functions, you will need to generate an SSH key and add it to your gitlab account. [https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key Here's a guide].
 
# Before you can properly use the online git functions, you will need to generate an SSH key and add it to your gitlab account. [https://git-scm.com/book/en/v2/Git-on-the-Server-Generating-Your-SSH-Public-Key Here's a guide].
 +
 +
[[Category:Modding]]

Revision as of 21:54, 26 July 2020

This article describes the process of setting up an online Git repository, and discusses the workflow.

Why do I Need a Repository?

The biggest benefit is to combine changes made by all members of the mod team into a single "current" copy. If you're working on a mod by yourself, you probably don't need an online repository. However, an offline one will still give you many other benefits, which online repositories also provide. If you break something, you can easily compare to the previous version (or rollback to it), and easily keep track of exactly what things you've changed since the previous version. Also, if valve update the source code, a repository can make the task of merging the two versions of the code considerably easier.

Getting Started

In this guide, the following applications and services are used:

  • Git
  • GitLab
  • GitKraken

First, it is necessary to install Git on our local machine and later set up the local and online repository.

  1. Download and install Git.
  2. First-time Git Setup - "Your Identity" is the important part of the article. This step is still optional, but will resolve headaches later.
  3. Register a free account at GitLab
  4. Before you can properly use the online git functions, you will need to generate an SSH key and add it to your gitlab account. Here's a guide.