Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit a14cf69

Browse files
committed
(docs): Adding a new page for the GitLab integration draft, the necessary screenshots, and also making changes to other pages like Smart Git Sync.
1 parent b6ee975 commit a14cf69

File tree

9 files changed

+99
-1
lines changed

9 files changed

+99
-1
lines changed
Loading
Loading
Loading
Loading
Loading
Loading

docs/getting-started/smart-git-sync.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The primary advantage of using Smart Git Sync is its ability to simplify the pro
2626
When you perform a new build on your Amplication project, Smart Git Sync automatically triggers the creation of a commit on the `amplication` branch.
2727

2828
:::note
29-
Amplication supports [GitHub](/sync-with-github), [Bitbucket](/sync-with-bitbucket), [AWS CodeCommit](/sync-with-aws-codecommit), and GitLab as git providers.
29+
Amplication supports [GitHub](/sync-with-github), [Bitbucket](/sync-with-bitbucket), [AWS CodeCommit](/sync-with-aws-codecommit), and [GitLab](/sync-with-gitlab) as git providers.
3030
:::
3131

3232
This commit encompasses all the files that were added, removed, or changed since the last build.
@@ -97,5 +97,6 @@ Smart Git Sync is a powerful feature that simplifies the integration between Amp
9797
Learn how to sync your service with your preferred git provider:
9898

9999
- [Sync With GitHub](/sync-with-github) (Free, Enterprise)
100+
- [Sync With GitLab](/sync-with-gitlab) (Enterprise)
100101
- [Sync With Bitbucket](/sync-with-bitbucket) (Enterprise)
101102
- [Sync With AWS CodeCommit](/sync-with-aws-codecommit) (Enterprise)
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
id: sync-with-gitlab
3+
title: Sync with GitLab
4+
sidebar_label: Sync with GitLab
5+
slug: /sync-with-gitlab
6+
toc_max_heading_level: 2
7+
---
8+
9+
# Sync with GitLab
10+
11+
Amplication provides seamless integration with GitLab repositories, enabling automated code synchronization for your services. This integration allows you to maintain full control of your generated code with GitLab's version control features.
12+
13+
## Add GitLab Organization
14+
15+
Follow these steps to add your GitLab organization:
16+
17+
1. Navigate to the [Service Catalog](/service-catalog)
18+
2. Select the **Git Settings** tab
19+
3. Click **Change Repository** if a repository is already connected
20+
4. Open the **Select Git Organization** dropdown
21+
5. Choose **Add Organization**
22+
6. Select GitLab from the provider list
23+
24+
![Add GitLab Org](./assets/sync-with-gitlab/add-gitlab-org.png)
25+
26+
## Authorize GitLab Access
27+
28+
When you select GitLab, you'll be redirected to GitLab's authorization page. Here you'll grant Amplication the necessary permissions to interact with your repositories.
29+
30+
![Authorize GitLab](./assets/sync-with-gitlab/authorize-gitlab.png)
31+
32+
## Configure Repository
33+
34+
After authorization, you'll have two options for repository setup:
35+
36+
### Option 1: Select Existing Repository
37+
38+
Choose from your available GitLab repositories in the repository selection modal.
39+
40+
![Select GitLab Repo](./assets/sync-with-gitlab/select-gitlab-repo.png)
41+
42+
### Option 2: Create New Repository
43+
44+
Click the "Create repository" button to set up a new GitLab repository.
45+
46+
![Create GitLab Repo](./assets/sync-with-gitlab/create-gitlab-repo.png)
47+
48+
## Service-Specific Repository Settings
49+
50+
Amplication provides two levels of Git configuration:
51+
52+
- **Project-level Git Settings**: Located in the Service Catalog's Git Settings tab, this controls the default repository settings for all services in your project
53+
- **Service-level Git Settings**: Found within each individual service's settings, this allows you to override the project-level configuration for specific services when needed
54+
55+
When you override the project settings for a service, that service will maintain its own independent Git configuration separate from the project defaults.
56+
57+
To configure Git settings for a specific service:
58+
59+
1. Access your service from the Service Catalog
60+
2. Navigate to the service's Git Settings page
61+
3. Toggle **Override project settings**
62+
4. Follow the repository setup steps to configure a service-specific repository
63+
64+
## Create Merge Requests
65+
66+
To push your changes to GitLab:
67+
68+
1. Make your desired changes in Amplication
69+
2. Access the pending changes sidebar in your service catalog
70+
3. Click "Generate the code" to initiate the build process
71+
72+
![GitLab Merge Request](./assets/sync-with-gitlab/merge-request.png)
73+
74+
## View Commits and Builds
75+
76+
To track your changes:
77+
78+
1. Go to your Service Catalog
79+
2. Click on the Commits tab
80+
3. View all your builds and their corresponding merge requests
81+
82+
:::important
83+
Do not delete the `amplication` branch. This branch is essential for Amplication's synchronization process.
84+
:::
85+
86+
![Create GitLab Repo](./assets/sync-with-gitlab/commit-and-build.png)
87+
88+
## Next Steps
89+
90+
Learn more about Amplication's Git integration features:
91+
92+
- Branch management strategies
93+
- Merge request workflows
94+
- Conflict resolution
95+
96+
Visit our [Smart Git Sync](/smart-git-sync) documentation for detailed information.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ const sidebars = {
7777
items: [
7878
"getting-started/smart-git-sync",
7979
"getting-started/sync-with-github",
80+
"getting-started/sync-with-gitlab",
8081
"getting-started/sync-with-bitbucket",
8182
"getting-started/sync-with-aws-codecommit",
8283
// "getting-started/sync-with-git-differences-between-plans",

0 commit comments

Comments
 (0)