# Git Sync

Git Sync feature allows users to import files directly from their Git repository into the DS Lab project to be used in the subsequent processes within pipelines and jobs. For using this feature, the user needs to configure their repository in their DS Lab project.

{% hint style="warning" %}
*<mark style="color:orange;">**Prerequisites:**</mark>*

* To configure GitLab/GitHub credentials, follow these steps in the ***Admin Settings***:
  * Navigate to ***Admin >> Configurations >> Version Control***.
  * From the first drop-down menu, select the *Version*.
  * Choose '***DsLabs***' as the module from the drop-down.
  * Select either ***GitHub*** or ***GitLab*** based on the requirement for Git type.
  * Enter the host for the selected Git type.
  * Provide the ***token key*** associated with the Git account.
  * Select a ***Git project***.
  * Choose the ***branch*** where the files are located.
  * After providing all the details correctly, click on '***Test***,' and if the authentication is successful, an appropriate message will appear. Subsequently, click on the '***Save***' option.
* To complete the configuration, navigate to ***My Account >> Configuration***. Enter the ***Git Token*** and ***Git Username***, then save the changes.
  {% endhint %}

## Configuring the Git Sync inside a DSL Project

Please follow the below-given steps to configure the Git Sync in the DS Lab project:

* Navigate to the DS Lab module.
* Click the ***Create Project*** to initiate a new project.
* Enter all the required fields for the project.
* Select the ***Git Repository*** and ***Git Branch.***
* Enable the option ***Sync git repo at project creation*** to gain access of all the files in the selected repository.
* Click the ***Save*** option to create the project.

<figure><img src="https://3157314867-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmyGSlDvDj86v7eh3RHM%2Fuploads%2F98VgX856dnKvMuEfugAq%2Fimage.png?alt=media&#x26;token=2e2350d2-335c-4da8-bc02-7326ca1b8f21" alt=""><figcaption><p><em><strong>Creating a Git Sync project</strong></em></p></figcaption></figure>

* After creating the project, expand the Repo option in the Notebook tab to view all files present in the repository.

<figure><img src="https://3157314867-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmyGSlDvDj86v7eh3RHM%2Fuploads%2FZp7DsxWDlfe39wULj60G%2Fimage.png?alt=media&#x26;token=c4b8d187-ea3b-40dc-bf39-f39d3f4a7b8a" alt=""><figcaption><p><em><strong>Accessing all the files in the repository</strong></em></p></figcaption></figure>

* The ***Git Console*** option, accessible by clicking at the bottom of the page, allows the user to run **Git commands** directly. This feature enables the user to execute any Git commands as per their specific requirements.

<figure><img src="https://3157314867-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvmyGSlDvDj86v7eh3RHM%2Fuploads%2FLUQJAaebFQGnHBg6f9qs%2Fimage.png?alt=media&#x26;token=ebb6b11f-f7aa-4e57-aa95-68440aaf1241" alt=""><figcaption><p><em><strong>Git Console</strong></em></p></figcaption></figure>

* After completing all the process, the users can export their scripts to the Data Pipeline module and register it as a job according to their specific requirements.
* For instructions on exporting script to the pipeline and registering it as a job, please refer to the link provided below:
  * [***Exporting a Script from DS Lab***](https://docs.bdb.ai/data-pipeline-4/getting-started/homepage/create/exporting-a-script-from-data-science-lab)
  * [***Register as Job***](https://docs.bdb.ai/data-pipeline-4/getting-started/homepage/create/register-as-job)

### Sample Git commands

```python
git init: #Initializes a new Git repository in the current directory.
git clone <repository-url>: #Clones a remote repository into a new local directory.
git add <file>: #Stages changes for the next commit.
git commit -m "Commit message": #Records staged changes in the repository with a descriptive message.
git status: #Displays the status of changes as untracked, modified, or staged.
git log: #Shows a commit history with commit IDs, authors, dates, and messages.
git branch: #Lists all branches in the repository.
git checkout <branch-name>: #Switches to the specified branch.
git merge <branch-name>: #Combines changes from the specified branch into the current branch.
git pull: #Fetches changes from a remote repository and merges them into the current branch.
git push: #Pushes local changes to a remote repository.
git remote -v: #Lists remote repositories linked to the local repository.
git fetch: #Retrieves changes from a remote repository without merging them.
git diff: #Shows the differences between working directory and last commit.
git rm <file>: #Removes a file from the working directory and stages the removal.
```

{% hint style="info" %}
*<mark style="color:green;">**Please Note:**</mark> Files with the  **.ipynb** extension can be exported for use in pipelines and jobs, while those with the **.py** extension can only be utilized as utility files.  Additional information on utility files can be found on the* [***Utility***](https://docs.bdb.ai/data-pipeline-4/getting-started/homepage/create/utility) *page.*
{% endhint %}