gitlab.mdx 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195
  1. ---
  2. title: GitLab
  3. description: Verwenden Sie OpenCode in GitLab-Issues und Merge Requests.
  4. ---
  5. OpenCode lässt sich über Ihre GitLab CI/CD-Pipeline oder mit GitLab Duo in Ihren GitLab-Workflow integrieren.
  6. In beiden Fällen läuft OpenCode auf Ihren GitLab Runners.
  7. ---
  8. ## GitLab CI
  9. OpenCode funktioniert in einer regulären GitLab-Pipeline. Sie können es als [CI component](https://docs.gitlab.com/ee/ci/components/) in eine Pipeline einbauen.
  10. Hier verwenden wir eine von der Community erstellte CI/CD-Komponente für OpenCode – [nagyv/gitlab-opencode](https://gitlab.com/nagyv/gitlab-opencode).
  11. ---
  12. ### Features
  13. - **Benutzerdefinierte Konfiguration pro Job verwenden**: Konfigurieren Sie OpenCode mit einem benutzerdefinierten Konfigurationsverzeichnis, zum Beispiel `./config/#custom-directory`, um die Funktionalität pro OpenCode-Aufruf zu aktivieren oder zu deaktivieren.
  14. - **Minimale Einrichtung**: Die CI-Komponente richtet OpenCode im Hintergrund ein. Sie müssen lediglich die OpenCode-Konfiguration und die erste Eingabeaufforderung erstellen.
  15. - **Flexibel**: Die CI-Komponente unterstützt mehrere Eingaben zum Anpassen ihres Verhaltens
  16. ---
  17. ### Setup
  18. 1. Speichern Sie Ihre OpenCode-Authentifizierung JSON als Umgebungsvariablen vom Dateityp CI unter **Einstellungen** > **CI/CD** > **Variablen**. Stellen Sie sicher, dass Sie sie als „Maskiert und ausgeblendet“ markieren.
  19. 2. Fügen Sie Folgendes zu Ihrer `.gitlab-ci.yml`-Datei hinzu.
  20. ```yaml title=".gitlab-ci.yml"
  21. include:
  22. - component: $CI_SERVER_FQDN/nagyv/gitlab-opencode/opencode@2
  23. inputs:
  24. config_dir: ${CI_PROJECT_DIR}/opencode-config
  25. auth_json: $OPENCODE_AUTH_JSON # The variable name for your OpenCode authentication JSON
  26. command: optional-custom-command
  27. message: "Your prompt here"
  28. ```
  29. Weitere Eingaben und Anwendungsfälle finden Sie unter [check out the docs](https://gitlab.com/explore/catalog/nagyv/gitlab-opencode) für diese Komponente.
  30. ---
  31. ## GitLab Duo
  32. OpenCode lässt sich in Ihren GitLab-Workflow integrieren.
  33. Erwähnen Sie `@opencode` in einem Kommentar und OpenCode führt Aufgaben innerhalb Ihrer GitLab CI-Pipeline aus.
  34. ---
  35. ### Features
  36. - **Issue Triage**: Bitten Sie OpenCode, ein Problem zu untersuchen und es Ihnen zu erklären.
  37. - **Reparieren und implementieren**: Bitten Sie OpenCode, ein Problem zu beheben oder eine Funktion zu implementieren.
  38. Es wird ein neuer Branch erstellt und eine Merge Request mit den Änderungen ausgelöst.
  39. - **Sicher**: OpenCode läuft auf Ihren GitLab Runners.
  40. ---
  41. ### Setup
  42. OpenCode wird in Ihrer GitLab CI/CD-Pipeline ausgeführt. Folgendes müssen Sie zum Einrichten benötigen:
  43. :::tip
  44. Aktuelle Anweisungen finden Sie im [**GitLab docs**](https://docs.gitlab.com/user/duo_agent_platform/agent_assistant/).
  45. :::
  46. 1. Konfigurieren Sie Ihre GitLab-Umgebung
  47. 2. CI/CD einrichten
  48. 3. Holen Sie sich einen AI-Modellanbieterschlüssel API
  49. 4. Erstellen Sie ein Dienstkonto
  50. 5. Konfigurieren Sie CI/CD-Variablen
  51. 6. Erstellen Sie eine Flow-Konfigurationsdatei, hier ist ein Beispiel:
  52. <details>
  53. <summary>Flow configuration</summary>
  54. ```yaml
  55. image: node:22-slim
  56. commands:
  57. - echo "Installing opencode"
  58. - npm install --global opencode-ai
  59. - echo "Installing glab"
  60. - export GITLAB_TOKEN=$GITLAB_TOKEN_OPENCODE
  61. - apt-get update --quiet && apt-get install --yes curl wget gpg git && rm --recursive --force /var/lib/apt/lists/*
  62. - curl --silent --show-error --location "https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository" | bash
  63. - apt-get install --yes glab
  64. - echo "Configuring glab"
  65. - echo $GITLAB_HOST
  66. - echo "Creating OpenCode auth configuration"
  67. - mkdir --parents ~/.local/share/opencode
  68. - |
  69. cat > ~/.local/share/opencode/auth.json << EOF
  70. {
  71. "anthropic": {
  72. "type": "api",
  73. "key": "$ANTHROPIC_API_KEY"
  74. }
  75. }
  76. EOF
  77. - echo "Configuring git"
  78. - git config --global user.email "[email protected]"
  79. - git config --global user.name "OpenCode"
  80. - echo "Testing glab"
  81. - glab issue list
  82. - echo "Running OpenCode"
  83. - |
  84. opencode run "
  85. You are an AI assistant helping with GitLab operations.
  86. Context: $AI_FLOW_CONTEXT
  87. Task: $AI_FLOW_INPUT
  88. Event: $AI_FLOW_EVENT
  89. Please execute the requested task using the available GitLab tools.
  90. Be thorough in your analysis and provide clear explanations.
  91. <important>
  92. Please use the glab CLI to access data from GitLab. The glab CLI has already been authenticated. You can run the corresponding commands.
  93. If you are asked to summarize an MR or issue or asked to provide more information then please post back a note to the MR/Issue so that the user can see it.
  94. You don't need to commit or push up changes, those will be done automatically based on the file changes you make.
  95. </important>
  96. "
  97. - git checkout --branch $CI_WORKLOAD_REF origin/$CI_WORKLOAD_REF
  98. - echo "Checking for git changes and pushing if any exist"
  99. - |
  100. if ! git diff --quiet || ! git diff --cached --quiet || [ --not --zero "$(git ls-files --others --exclude-standard)" ]; then
  101. echo "Git changes detected, adding and pushing..."
  102. git add .
  103. if git diff --cached --quiet; then
  104. echo "No staged changes to commit"
  105. else
  106. echo "Committing changes to branch: $CI_WORKLOAD_REF"
  107. git commit --message "Codex changes"
  108. echo "Pushing changes up to $CI_WORKLOAD_REF"
  109. git push https://gitlab-ci-token:$GITLAB_TOKEN@$GITLAB_HOST/gl-demo-ultimate-dev-ai-epic-17570/test-java-project.git $CI_WORKLOAD_REF
  110. echo "Changes successfully pushed"
  111. fi
  112. else
  113. echo "No git changes detected, skipping push"
  114. fi
  115. variables:
  116. - ANTHROPIC_API_KEY
  117. - GITLAB_TOKEN_OPENCODE
  118. - GITLAB_HOST
  119. ```
  120. </details>
  121. Ausführliche Anweisungen finden Sie unter [GitLab CLI agents docs](https://docs.gitlab.com/user/duo_agent_platform/agent_assistant/).
  122. ---
  123. ### Examples
  124. Hier sind einige Beispiele, wie Sie OpenCode in GitLab verwenden können.
  125. :::tip
  126. Sie können die Verwendung einer anderen Triggerphrase als `@opencode` konfigurieren.
  127. :::
  128. - **Erklären Sie ein Problem**
  129. Fügen Sie diesen Kommentar in einer GitLab-Ausgabe hinzu.
  130. ```
  131. @opencode explain this issue
  132. ```
  133. OpenCode liest das Problem und antwortet mit einer klaren Erklärung.
  134. - **Ein Problem beheben**
  135. Sagen Sie in einer GitLab-Ausgabe:
  136. ```
  137. @opencode fix this
  138. ```
  139. OpenCode erstellt einen neuen Branch, implementiert die Änderungen und öffnet eine Merge Request mit den Änderungen.
  140. - **Merge Requests prüfen**
  141. Hinterlassen Sie den folgenden Kommentar zu einer GitLab Merge Request.
  142. ```
  143. @opencode review this merge request
  144. ```
  145. OpenCode prüft die Merge Request und gibt Feedback.