GitLab Development Kit
Motivation:
The GitLab Development Kit (GDK) is a tool designed to simplify setting up a development environment and running tests locally for GitLab.
Key Features:
Environment Setup: GDK automatically sets up all required dependencies, including databases, message queues, and other services, for a complete GitLab environment.
Local Development: GDK allows developers to work on GitLab code locally, making it possible to debug and test changes without directly interacting with the production environment.
Automated Tests: GDK integrates with GitLab’s comprehensive test suite, enabling developers to run unit, integration, and system tests locally.
Streamlined Workflow: GDK streamlines the development process, reducing setup time and simplifying the testing process, allowing developers to focus on writing and iterating on GitLab features.
Getting Started:
Installation:
- Install the required dependencies:
Setup:
- Clone the GitLab repository:
git clone https://gitlab.com/gitlab-org/gitlab.git
- Navigate to the GitLab repository directory:
cd gitlab
- Run GDK setup:
gdk setup
- Clone the GitLab repository:
Usage:
Running GDK:
- Start GDK:
gdk start
- Start GDK:
Accessing GitLab:
- Access the local GitLab instance:
Available Options:
gdk setup
: Sets up the GDK environment for the first time.gdk start
: Starts the GDK environment.gdk stop
: Stops the GDK environment.gdk restart
: Restarts the GDK environment.gdk down
: Stops and cleans up the GDK environment.gdk shell
: Opens a shell within the GDK environment.gdk logs
: Displays the logs of the GDK environment.gdk test
: Runs the GitLab test suite.gdk build
: Builds the GitLab application.gdk deploy
: Deploys the GitLab application.gdk help
: Displays help information for GDK.
Examples:
- Start GDK:
gdk start
- Run GitLab tests:
gdk test
- Open a shell in the GDK environment:
gdk shell
- Clean up the GDK environment:
gdk down
Further Information: