> For the complete documentation index, see [llms.txt](https://docs.uibakery.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.uibakery.io/on-premise/git-source-control/automate-gitlab-releases.md).

# Automate GitLab releases

Automatically release the UI Bakery app upon merging a merge request

## Step 1. Enable the Instance API

To enable the UI Bakery Instance API please follow this [guide](/on-premise/on-premise-features/instance-api.md#enabling-the-instance-api)

## Step 2. Create GitLab pipeline

To create a release pipeline follow this steps:

* Go to **Build/Pipeline Editor** tab
* Click **Configure Pipeline**
* Paste the following content:

```yaml
stages: 
  - deploy

deploy-job:      
  stage: deploy
  environment: production
  only: ["main"]
  script:
    - |
        curl https://UI_BAKERY_INSTANCE/api/instance/app/APP_ID/pull?uib_branch=main \
        -X POST \
        -H "Content-Type: application/json" \
        -H "Authorization: Bearer TOKEN"
    - |
        curl https://UI_BAKERY_INSTANCE/api/instance/app/APP_ID/release \
        -X POST \
        -d '{"version":"1.0.1", "prod": true, "staging": false, "description": "Automated release"}' \
        -H "Content-Type: application/json" \
        -H "Authorization: Bearer TOKEN"
    - echo "Application successfully deployed."
```

* Replace the `UI_BAKERY_INSTANCE` placeholder with your domain name.
* Replace `APP_ID` with your app ID (can be found in URL).
* Replace `TOKEN` with the value of your `UI_BAKERY_INSTANCE_API_TOKEN` variable

The pipeline will be executed on every push/merge into the "main" branch


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.uibakery.io/on-premise/git-source-control/automate-gitlab-releases.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.