GitLab

https://docs.gitlab.com/18.4/
Admin
GitLab is a comprehensive DevOps platform that provides version control, CI/CD, project management,...
Tokens:9,167,581
Snippets:52,166
Trust Score:10
Update:22 hours ago
Show doc for...
Tokens:
Raw
### Example devfile with postStart events

Source: https://docs.gitlab.com/18.4/user/workspace/

Complete example devfile configuration demonstrating postStart events with multiple components, environment variables, endpoints, and commands with and without workingDir.

```yaml
schemaVersion: 2.2.0
variables:
  registry-root: registry.gitlab.com
components:
  - name: tooling-container
    attributes:
      gl/inject-editor: true
    container:
      image: "{{registry-root}}/gitlab-org/remote-development/gitlab-remote-development-docs/ubuntu:22.04"
      env:
        - name: KEY
          value: VALUE
      endpoints:
        - name: http-3000
          targetPort: 3000
  - name: database-container
    container:
      image: mysql
      env:
        - name: MYSQL_ROOT_PASSWORD
          value: "my-secret-pw"
commands:
  # Command 1: Container 1, no working directory (uses project directory)
  - id: install-dependencies
    exec:
      component: tooling-container
      commandLine: "npm install"

  # Command 2: Container 1, with working directory
  - id: setup-environment
    exec:
      component: tooling-container
      commandLine: "echo 'Setting up development environment'"
      workingDir: "/home/gitlab-workspaces"

  # Command 3: Container 2, no working directory (uses container default)
  - id: init-database
    exec:
      component: database-container
      commandLine: "echo 'Database initialized' > db-init.log"

  # Command 4: Container 2, with working directory
  - id: setup-database
    exec:
      component: database-container
      commandLine: "mkdir -p /var/lib/mysql/logs && echo 'DB setup complete' > setup.log"
      workingDir: "/var/lib/mysql"

events:
  postStart:
    - install-dependencies
    - setup-environment
    - init-database
    - setup-database
```

--------------------------------

### Description style examples

Source: https://docs.gitlab.com/18.4/development/api_graphql_styleguide/

Examples of description text following the style guide: using '{x} of the {y}' format, starting with a verb for booleans, and providing defaults when necessary.

```plaintext
ID of the issue.
```

```plaintext
Author of the epics.
```

```plaintext
Sort issues by this criteria.
```

```plaintext
Indicates the issue is confidential.
```

```plaintext
Sets the issue to confidential. Default is false.
```

```plaintext
Values for sorting container repositories.
```

--------------------------------

### Add __init__.py content

Source: https://docs.gitlab.com/18.4/user/packages/workflows/build_packages/

Import SayHello from the greet module in __init__.py.

```python
from .greet import SayHello
```

--------------------------------

### curl request to get file blame range

Source: https://docs.gitlab.com/18.4/api/repository_files/

Example curl command to request a blame range by specifying range[start] and range[end] parameters.

```shell
curl --head --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/13083/repository/files/path%2Fto%2Ffile.rb/blame?ref=main&range[start]=1&range[end]=2"
```

--------------------------------

### Example connection string output

Source: https://docs.gitlab.com/18.4/charts/advanced/external-object-storage/azure-minio-gateway/

Example JSON output from the previous command, showing the connection string format with the account key.

```json
{
    "connectionString": "DefaultEndpointsProtocol=https;EndpointSuffix=core.windows.net;AccountName=gitlab-azure-minio-storage;AccountKey=h0tSyeTebs+..."
}
```

--------------------------------

### List all group or project migrations - JSON response

Source: https://docs.gitlab.com/18.4/api/bulk_imports/

Example JSON response for the GET /bulk_imports endpoint, showing two migrations with statuses finished and started.

```json
[
    {
        "id": 1,
        "status": "finished",
        "source_type": "gitlab",
        "source_url": "https://gitlab.example.com",
        "created_at": "2021-06-18T09:45:55.358Z",
        "updated_at": "2021-06-18T09:46:27.003Z",
        "has_failures": false
    },
    {
        "id": 2,
        "status": "started",
        "source_type": "gitlab",
        "source_url": "https://gitlab.example.com",
        "created_at": "2021-06-18T09:47:36.581Z",
        "updated_at": "2021-06-18T09:47:58.286Z",
        "has_failures": false
    }
]
```

--------------------------------

### Example .gitlab-ci.yml for hosted Windows runners

Source: https://docs.gitlab.com/18.4/ci/runners/hosted_runners/windows/

Use this example to get started with hosted runners on Windows. It defines a .windows_job template with the saas-windows-medium-amd64 tag and PowerShell before_script, then extends it for build and test jobs. The script sections use PowerShell commands.

```yaml
.windows_job:
  tags:
    - saas-windows-medium-amd64
  before_script:
    - Set-Variable -Name "time" -Value (date -Format "%H:%m")
    - echo ${time}
    - echo "started by ${GITLAB_USER_NAME} / @${GITLAB_USER_LOGIN}"

build:
  extends:
    - .windows_job
  stage: build
  script:
    - echo "running scripts in the build job"

test:
  extends:
    - .windows_job
  stage: test
  script:
    - echo "running scripts in the test job"
```

--------------------------------

### deployment livenessProbe and readinessProbe configuration example

Source: https://docs.gitlab.com/18.4/charts/charts/gitlab/spamcheck/

Example YAML for configuring liveness and readiness probes for Spamcheck pods. Includes initialDelaySeconds, periodSeconds, timeoutSeconds, successThreshold, and failureThreshold settings.

```yaml
deployment:
  livenessProbe:
    initialDelaySeconds: 10
    periodSeconds: 20
    timeoutSeconds: 3
    successThreshold: 1
    failureThreshold: 10
  readinessProbe:
    initialDelaySeconds: 10
    periodSeconds: 5
    timeoutSeconds: 2
    successThreshold: 1
    failureThreshold: 3
```

--------------------------------

### Get a topic - example response

Source: https://docs.gitlab.com/18.4/api/topics/

Example JSON response for a successful get topic request.

```json
{
  "id": 1,
  "name": "gitlab",
  "title": "GitLab",
  "description": "GitLab is an open source end-to-end software development platform with built-in version control, issue tracking, code review, CI/CD, and more.",
  "total_projects_count": 1000,
  "organization_id": 1,
  "avatar_url": "http://www.gravatar.com/avatar/a0d477b3ea21970ce6ffcbb817b0b435?s=80&d=identicon"
}
```

--------------------------------

### Enable Deploy Key - Example Response

Source: https://docs.gitlab.com/18.4/api/deploy_keys/

Example JSON response returned when a deploy key is successfully enabled. Contains the key, ID, title, creation date, and expiration date.

```json
{
  "key": "ssh-rsa AAAA...",
  "id": 12,
  "title": "My deploy key",
  "created_at": "2015-08-29T12:44:31.550Z",
  "expires_at": null
}
```

--------------------------------

### Get a topic - example request

Source: https://docs.gitlab.com/18.4/api/topics/

Example curl request to get topic with ID 1.

```shell
curl --request GET \
  --url "https://gitlab.example.com/api/v4/topics/1"
```

--------------------------------

### Create a Kind cluster with SSL configuration

Source: https://docs.gitlab.com/18.4/charts/development/kind/

Spin up a Kind cluster using the example configuration file examples/kind/kind-ssl.yaml. Review and adjust the configuration as needed.

```shell
kind create cluster --config examples/kind/kind-ssl.yaml
```

--------------------------------

### Set up *.test domain lookup with dnsmasq

Source: https://docs.gitlab.com/18.4/development/pages/dnsmasq/

Creates the configuration directory, adds a line to dnsmasq.conf to resolve *.test to 127.0.0.1, and starts the dnsmasq service. Requires sudo for starting the service.

```console
# Ensure the configuration directory exists
mkdir -p $(brew --prefix)/etc/

# Add `*.test` to the `127.0.0.1` lookup
echo 'address=/.test/127.0.0.1' >> $(brew --prefix)/etc/dnsmasq.conf

# Start `dnsmasq`
sudo brew services start dnsmasq
```

--------------------------------

### Get SAML identities for a group - example response

Source: https://docs.gitlab.com/18.4/api/saml/

Example JSON response for the GET /groups/:id/saml/identities endpoint.

```json
[
    {
        "extern_uid": "yrnZW46BrtBFqM7xDzE7dddd",
        "user_id": 48
    }
]
```

--------------------------------

### Example response for create deployment

Source: https://docs.gitlab.com/18.4/api/deployments/

Example JSON response for a successful deployment creation.

```json
{
  "id": 42,
  "iid": 2,
  "ref": "main",
  "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
  "created_at": "2016-08-11T11:32:35.444Z",
  "status": "success",
  "user": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://localhost:3000/root"
  },
  "environment": {
    "id": 9,
    "name": "production",
    "external_url": "https://about.gitlab.com"
  },
  "deployable": null
}
```

--------------------------------

### Install Jenkins and start service with Homebrew

Source: https://docs.gitlab.com/18.4/development/integrations/jenkins/

Use Homebrew to install Jenkins and start the service. Run these commands in your terminal.

```shell
brew install jenkins
brew services start jenkins
```

--------------------------------

### GET /user/preferences example response

Source: https://docs.gitlab.com/18.4/api/users/

Example JSON response for the GET /user/preferences endpoint, showing user preference fields.

```json
{
  "id": 1,
  "user_id": 1,
  "view_diffs_file_by_file": true,
  "show_whitespace_in_diffs": false,
  "pass_user_identities_to_ci_jwt": false
}
```

--------------------------------

### Create an instance service account - example response

Source: https://docs.gitlab.com/18.4/api/service_accounts/

Example JSON response for creating an instance service account, showing the created service account with id, username, name, and email.

```json
{
  "id": 57,
  "username": "service_account_6018816a18e515214e0c34c2b33523fc",
  "name": "Service account user",
  "email": "service_account_6018816a18e515214e0c34c2b33523fc@noreply.gitlab.example.com"
}
```

--------------------------------

### Set up Python with Mise

Source: https://docs.gitlab.com/18.4/development/python_guide/getting_started/

Use Mise to install and use a specific Python version. This is an alternative to installing Python from the official website.

```shell
mise use [email protected]
```

--------------------------------

### Get a GPG key - Example response

Source: https://docs.gitlab.com/18.4/api/user_keys/

Example JSON response for a successful GET request to retrieve a GPG key.

```json
{
  "id": 1,
  "key": "<PGP_PUBLIC_KEY_BLOCK>",
  "created_at": "2017-09-05T09:17:46.264Z"
}
```

--------------------------------

### Create relative_url.rb from sample

Source: https://docs.gitlab.com/18.4/install/relative_url/

Copies the sample initializer to the actual file that will be edited.

```shell
cp /home/git/gitlab/config/initializers/relative_url.rb.sample \
   /home/git/gitlab/config/initializers/relative_url.rb
```

--------------------------------

### Get a single SAML identity - example response

Source: https://docs.gitlab.com/18.4/api/saml/

Example JSON response for the GET /groups/:id/saml/:uid endpoint.

```json
{
    "extern_uid": "yrnZW46BrtBFqM7xDzE7dddd",
    "user_id": 48
}
```

--------------------------------

### Example response for GET protected environment

Source: https://docs.gitlab.com/18.4/api/group_protected_environments/

Example JSON response for the GET request, showing the protected environment details.

```json
{
   "name":"production",
   "deploy_access_levels":[
      {
         "id": 12,
         "access_level":40,
         "access_level_description":"Maintainers",
         "user_id":null,
         "group_id":null
      }
   ],
   "required_approval_count": 0
}
```

--------------------------------

### Create a project deploy token - example response

Source: https://docs.gitlab.com/18.4/api/deploy_tokens/

Example JSON response for creating a deploy token. Includes the generated token value.

```json
{
  "id": 1,
  "name": "My deploy token",
  "username": "custom-user",
  "expires_at": "2021-01-01T00:00:00.000Z",
  "token": "jMRvtPNxrn3crTAGukpZ",
  "revoked": false,
  "expired": false,
  "scopes": [
    "read_repository"
  ]
}
```

--------------------------------

### Example response for add deploy key

Source: https://docs.gitlab.com/18.4/api/deploy_keys/

Example JSON response returned after successfully creating a deploy key. Includes id, title, key, fingerprints, usage_type, created_at, and expires_at.

```json
{
  "id": 5,
  "title": "My deploy key",
  "key": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAAAgQDNJAkI3Wdf0r13c8a5pEExB2YowPWCSVzfZV22pNBc1CuEbyYLHpUyaD0GwpGvFdx2aP7lMEk35k6Rz3ccBF6jRaVJyhsn5VNnW92PMpBJ/P1UebhXwsFHdQf5rTt082cSxWuk61kGWRQtk4ozt/J2DF/dIUVaLvc+z4HomT41fQ==",
  "fingerprint": "4a:9d:64:15:ed:3a:e6:07:6e:89:36:b3:3b:03:05:d9",
  "fingerprint_sha256": "SHA256:Jrs3LD1Ji30xNLtTVf9NDCj7kkBgPBb2pjvTZ3HfIgU",
  "usage_type": "auth_and_signing",
  "created_at": "2024-10-03T01:32:21.992Z",
  "expires_at": "2024-12-31T08:00:00.000Z"
}
```

--------------------------------

### Install curl for GitLab repository setup

Source: https://docs.gitlab.com/18.4/install/package/almalinux/

Installs curl, required to download and run the GitLab repository setup script.

```shell
sudo dnf install -y curl
```

--------------------------------

### Add deploy key for a project - example response

Source: https://docs.gitlab.com/18.4/api/deploy_keys/

Example JSON response for a successful add deploy key request. Contains the key, id, title, can_push, created_at, and expires_at fields.

```json
{
  "key": "ssh-rsa AAAA...",
  "id": 12,
  "title": "My deploy key",
  "can_push": true,
  "created_at": "2015-08-29T12:44:31.550Z",
  "expires_at": null
}
```

--------------------------------

### Start a Ruby on Rails console

Source: https://docs.gitlab.com/18.4/development/import_project/

Start a Rails console to import the project manually. Use the Omnibus GitLab command for Omnibus installations, or the source installation command for installations from source.

```shell
# Omnibus GitLab
gitlab-rails console

# For installations from source
sudo -u git -H bundle exec rails console -e production
```

--------------------------------

### Get feature flag user list - example response

Source: https://docs.gitlab.com/18.4/api/feature_flag_user_lists/

Example JSON response after getting a feature flag user list.

```json
{
   "name": "my_user_list",
   "user_xids": "123,456",
   "id": 1,
   "iid": 1,
   "project_id": 1,
   "created_at": "2020-02-04T08:13:10.507Z",
   "updated_at": "2020-02-04T08:13:10.507Z"
}
```

--------------------------------

### Get a project deploy token - example response

Source: https://docs.gitlab.com/18.4/api/deploy_tokens/

Example JSON response for a single project deploy token. Contains the same fields as list responses but as a single object.

```json
{
  "id": 1,
  "name": "MyToken",
  "username": "gitlab+deploy-token-1",
  "expires_at": "2020-02-14T00:00:00.000Z",
  "revoked": false,
  "expired": false,
  "scopes": [
    "read_repository",
    "read_registry"
  ]
}
```

--------------------------------

### Create a subscription: example JSON response

Source: https://docs.gitlab.com/18.4/development/internal_api/gitlab_subscriptions/

Example response from a successful create subscription request. Shows the created plan, usage, and billing details.

```json
{
  "plan": {
    "code":"premium",
    "name":"premium",
    "trial":false,
    "auto_renew":null,
    "upgradable":false
  },
  "usage": {
    "seats_in_subscription":10,
    "seats_in_use":1,
    "max_seats_used":0,
    "seats_owed":0
  },
  "billing": {
    "subscription_start_date":"2020-07-15",
    "subscription_end_date":null,
    "trial_ends_on":null
  }
}
```

--------------------------------

### Start imapd

Source: https://docs.gitlab.com/18.4/administration/reply_by_email_postfix_setup/

Starts the IMAP daemon after installation.

```shell
imapd start
```
Tokens:
Raw