Add GitLab support with API-compatible utility functions.

.github/workflows/git-bob.yml

@@ -55,6 +55,7 @@ jobs:
         KISSKI_API_KEY: "${{ secrets.KISSKI_API_KEY }}"
         BLABLADOR_API_KEY: "${{ secrets.BLABLADOR_API_KEY }}"
         GITHUB_API_KEY: "${{ secrets.GITHUB_TOKEN }}"
+        GITLAB_API_KEY: "${{ secrets.GITLAB_API_KEY }}"
         GITHUB_RUN_ID: "${{ github.run_id }}"
         TWINE_USERNAME: "${{ secrets.TWINE_USERNAME }}"
         TWINE_PASSWORD: "${{ secrets.TWINE_PASSWORD }}"

.github/workflows/pytest.yml

@@ -30,6 +30,8 @@ jobs:
         pip install -e .
 
     - name: Test with pytest and generate coverage
+      env:
+        GITLAB_API_KEY: "${{ secrets.GITLAB_API_KEY }}"
       run: |
         pytest --cov=./ --cov-report=xml
 

.gitlab/.gitlab-ci.yml

@@ -0,0 +1,59 @@
+stages:
+  - respond
+
+respond:
+  stage: respond
+  image: ubuntu:latest
+
+  rules:
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+    - if: $CI_PIPELINE_SOURCE == "push"
+    - if: $CI_PIPELINE_SOURCE == "web"
+    - if: $CI_PIPELINE_SOURCE == "trigger" && $CI_PIPELINE_TRIGGER_SOURCE == "issue"
+
+  before_script:
+    - apt-get update && apt-get install -y python3 python3-pip git python3-venv
+    - python3 -m venv venv  # Create a virtual environment
+    - source venv/bin/activate  # Activate the virtual environment
+    - pip install --upgrade pip  # Upgrade pip within the virtual environment
+
+
+  script:
+    - echo "Merge Request IID - $CI_MERGE_REQUEST_IID"
+    - echo "Project Namespace - $CI_PROJECT_NAMESPACE"
+    - echo "Project Name - $CI_PROJECT_NAME"
+    - echo "Pipeline ID - $CI_PIPELINE_ID"
+    - echo "Job ID - $CI_JOB_ID"
+
+    - pip install git-bob==0.10.0
+    - pip install -r requirements.txt
+
+    - |
+      git-bob github-action $CI_PROJECT_PATH $CI_MERGE_REQUEST_IID $CI_OPEN_MERGE_REQUESTS_IID
+
+  variables:
+    GIT_BOB_AGENT_NAME: "git-bob"
+    GIT_BOB_LLM_NAME: "$GIT_BOB_LLM_NAME"
+    ANTHROPIC_API_KEY: "$ANTHROPIC_API_KEY"
+    GOOGLE_API_KEY: "$GOOGLE_API_KEY"
+    OPENAI_API_KEY: "$OPENAI_API_KEY"
+    GH_MODELS_API_KEY: "$GH_MODELS_API_KEY"
+    KISSKI_API_KEY: "$KISSKI_API_KEY"
+    BLABLADOR_API_KEY: "$BLABLADOR_API_KEY"
+    GITLAB_API_KEY: "$GITLAB_API_TOKEN"
+    GITLAB_PIPELINE_ID: "$CI_PIPELINE_ID"
+    GIT_SERVER_URL: "https://gitlab.com/"
+    TWINE_USERNAME: "$TWINE_USERNAME"
+    TWINE_PASSWORD: "$TWINE_PASSWORD"
+    SYSTEM_MESSAGE: |
+      You are an extremely skilled python developer. Your name is git-bob. You are sometimes called gitlab-ci bot.
+      You can solve programming tasks and review code.
+      When asked to solve a specific problem, you keep your code changes minimal and only solve the problem at hand.
+      You cannot retrieve information from other sources but from gitlab.com.
+      Do not claim anything that you don't know.
+      In case you are asked to review code, you focus on the quality of the code.
+    VISION_SYSTEM_MESSAGE: |
+      You are an AI-based vision model with excellent skills when it comes to describing image. When describing an image, you typically explain:
+      * What is shown in the image.
+      * If the image shows clearly distinct objects in its channels, these structures are listed for each channel individually.
+      * You speculate how the image was acquired.

README.md

@@ -55,6 +55,10 @@ Furthermore, to guide discussions, you may want to setup issue templates, e.g.
 * [Bio-Image Analysis](https://github.com/haesleinhuepf/git-bob-playground/blob/main/.github/ISSUE_TEMPLATE/bioimage_analysis.md)
 * [Statistics and Plotting](https://github.com/haesleinhuepf/git-bob-playground/blob/main/.github/ISSUE_TEMPLATE/statistics_plotting.md)
 
+## Installation as gitlab pipeline
+
+Since version 0.10.0 git-bob has experimental support for [gitlab](https://gitlab.com). You find detailed instructions how to install it [here](docs/installation-tutorial-gitlab.md).
+
 ## Usage
 
 To trigger git-bob, you need to comment on an issue or pull request with the following command:
@@ -114,6 +118,7 @@ Here's the recommended workflow for using git-bob:
 * [Basic data analysis and plotting](https://github.com/NFDI4BIOIMAGE/training/issues/250)
 * [Documenting source code](https://github.com/haesleinhuepf/git-bob/pull/29)
 * [Assisting scientific manuscript writing](https://github.com/haesleinhuepf/git-bob-manuscript/pull/9)
+* [Plotting a circle of triangles (in gitlab)](https://gitlab.com/haesleinhuepf/git-bob-gitlab-playground/-/issues/8)
 
 ## Installation for development
 

docs/installation-tutorial-gitlab.md

@@ -0,0 +1,84 @@
+# Installation in git-lab
+
+Since version 0.10.0 git-bob has experimental support for [gitlab](https://gitlab.com).
+Feedback about the instructions provided here are very [welcome](https://github.com/haesleinhuepf/git-bob/issues/new)!
+
+For demonstration purposes, a [playground repository on gitlab.com](https://gitlab.com/haesleinhuepf/git-bob-gitlab-playground) has been set up as demonstrated in the following.
+
+## Create a new repository
+
+* Create a new repository in your gitlab instance or on [https://gitlab.com](https://gitlab.com). 
+* Add the [.gitlab-ci.yml](../.gitlab/.gitlab-ci.yml) to the root folder of your repository. 
+  In this file, make the following modifications:
+  * If you are working with an own gitlab instance, modify the variable `GIT_SERVER_URL`. Enter the url of your server and finish with "/".
+  * In the line `- pip install git-bob==0.10.0` consider updating the version number.
+* Add a requirements.txt (or remove the line `- pip install -r requirements.txt`) from the yml file.
+
+## Setting access tokens
+
+In the gitlab web interface, go to project settings > CI / CD > Variables. 
+Add new variables named `GIT_BOB_LLM_NAME`, `OPENAI_API_KEY`, `GH_MODELS_API_KEY`, `ANTHROPIC_API_KEY`, `GOOGLE_API_KEY` (depending on which LLM service provide you wish to use).
+
+![img.png](images/install-gitlab1.png)
+
+IMPORTANT: There seems a bug currently in the interface. After adding one variable, reload the page and click on "Add variable again".
+Ensure that all created variables have the settings `Protected`, `Masked`, `Hidden` as shown here:
+
+![img_6.png](images/install-gitlab2a.png)
+
+Also configure a variable named `GITLAB_API_KEY`. You can retrieve this key from User > Preferences > Access Tokens.
+
+![img.png](images/install-gitlab2.png)
+
+When creating this key, make sure to select "api", "read repository" and "write repository":
+
+![img_1.png](images/install-gitlab3.png)
+
+This API key needs to be added as variable `GITLAB_API_KEY` as explained above. 
+DO NOT share this key with anyone and DO NOT save it in any file that is visible on the internet.
+
+## Pipeline triggering
+
+Next, we need to configure that new issues trigger git-bob. 
+You can also read more about how to do this in the [git lab documentation](https://docs.gitlab.com/ee/ci/triggers/).
+
+Go to Project settings > CI / CD > Pipeline Trigger Tokens and create a token. 
+Copy the token, you will need it in the next step.
+
+![img.png](images/install-gitlab4.png)
+
+## Web hooks
+
+Go to Project settings > Webhooks and create a new webhook.
+
+![img_1.png](images/install-gitlab5.png)
+
+As URL specify the following. Replace PROJECT_ID by your project's ID (a long number) and the TOKEN by the pipeline token you received above.
+```
+https://gitlab.com/api/v4/projects/PROJECT_ID/ref/main/trigger/pipeline?token=TOKEN&variables[CI_PIPELINE_TRIGGER_SOURCE]=issue
+```
+
+Then, configure masks to hide the token again, e.g. like this:
+
+![img_2.png](images/install-gitlab6.png)
+
+Also make sure to configure triggers: Comments, Issue events, Merge request events
+
+![img_3.png](images/install-gitlab7.png)
+
+In the list of web hooks it should then look like this:
+
+![img_4.png](images/install-gitlab8.png)
+
+## Testing the installation
+
+Go to your repository and create a new issue ([example](https://gitlab.com/haesleinhuepf/git-bob-gitlab-playground/-/issues/2)). E.g. write a request like this and use a trigger word for git-bob:
+```
+What is the capital of Germany?
+
+git-bob comment
+```
+
+If everything is configured correctly, git-bob will respond in your name, because it uses your Gitlab API key:
+
+![img_5.png](images/install-gitlab9.png)