GitLab
GitLabのプロジェクト、課題、マージリクエスト、パイプラインとやり取りする
GitLabは、チームがソフトウェア開発ライフサイクルを管理、共同作業、自動化できる包括的なDevOpsプラットフォームです。GitLabを使用すると、ソースコード管理、CI/CD、レビュー、コラボレーションを単一のアプリケーションで簡単に処理できます。
SimでGitLabを使用すると、以下のことができます:
- プロジェクトとリポジトリの管理:GitLabプロジェクトの一覧表示と取得、詳細へのアクセス、リポジトリの整理
- 課題の操作:作業を追跡し効果的に共同作業するための課題の一覧表示、作成、コメント
- マージリクエストの処理:コード変更とピアレビューのためのマージリクエストのレビュー、作成、管理
- CI/CDパイプラインの自動化:自動化フローの一部としてGitLabパイプラインのトリガー、監視、操作
- コメントによる共同作業:チーム内の効率的なコミュニケーションのために課題やマージリクエストにコメントを追加
SimのGitLab統合を使用すると、エージェントはプログラムでGitLabプロジェクトとやり取りできます。プロジェクト管理、課題追跡、コードレビュー、パイプライン操作をワークフローでシームレスに自動化し、ソフトウェア開発プロセスを最適化し、チーム全体のコラボレーションを強化します。
GitLabをワークフローに統合します。プロジェクト、課題、マージリクエスト、パイプライン、コメントを管理できます。GitLabのすべての主要なDevOps操作をサポートしています。
認証されたユーザーがアクセスできるGitLabプロジェクトを一覧表示
| パラメータ | 型 | 必須 | 説明 |
|---|
owned | boolean | いいえ | 現在のユーザーが所有するプロジェクトに限定 |
membership | boolean | いいえ | 現在のユーザーがメンバーであるプロジェクトに限定 |
search | string | いいえ | 名前でプロジェクトを検索 |
visibility | string | いいえ | 可視性でフィルタリング(public、internal、private) |
orderBy | string | いいえ | フィールドで並べ替え(id、name、path、created_at、updated_at、last_activity_at) |
sort | string | いいえ | 並べ替え方向(asc、desc) |
perPage | number | いいえ | ページあたりの結果数(デフォルト20、最大100) |
page | number | いいえ | ページネーションのページ番号 |
| パラメータ | 型 | 説明 |
|---|
projects | array | GitLabプロジェクトのリスト |
total | number | プロジェクトの総数 |
特定のGitLabプロジェクトの詳細を取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス(例:"namespace/project") |
| パラメータ | 型 | 説明 |
|---|
project | object | GitLabプロジェクトの詳細 |
GitLabプロジェクト内の課題を一覧表示する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
state | string | いいえ | 状態によるフィルタリング(opened、closed、all) |
labels | string | いいえ | カンマ区切りのラベル名リスト |
assigneeId | number | いいえ | 担当者ユーザーIDによるフィルタリング |
milestoneTitle | string | いいえ | マイルストーンタイトルによるフィルタリング |
search | string | いいえ | タイトルと説明で課題を検索 |
orderBy | string | いいえ | フィールドによる並べ替え(created_at、updated_at) |
sort | string | いいえ | 並べ替え方向(asc、desc) |
perPage | number | いいえ | ページあたりの結果数(デフォルト20、最大100) |
page | number | いいえ | ページネーションのページ番号 |
| パラメータ | 型 | 説明 |
|---|
issues | array | GitLab課題のリスト |
total | number | 課題の総数 |
特定のGitLab課題の詳細を取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
issueIid | number | はい | プロジェクト内の課題番号(GitLab UIに表示される#) |
| パラメータ | 型 | 説明 |
|---|
issue | object | GitLab課題の詳細 |
GitLabプロジェクトに新しい課題を作成する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
title | string | はい | 課題のタイトル |
description | string | いいえ | 課題の説明(Markdown対応) |
labels | string | いいえ | カンマ区切りのラベル名リスト |
assigneeIds | array | いいえ | 割り当てるユーザーIDの配列 |
milestoneId | number | いいえ | 割り当てるマイルストーンID |
dueDate | string | いいえ | YYYY-MM-DD形式の期限日 |
confidential | boolean | いいえ | 課題が機密扱いかどうか |
| パラメータ | 型 | 説明 |
|---|
issue | object | 作成されたGitLab課題 |
GitLabプロジェクト内の既存の課題を更新する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
issueIid | number | はい | 課題内部ID(IID) |
title | string | いいえ | 新しい課題のタイトル |
description | string | いいえ | 新しい課題の説明(Markdown対応) |
stateEvent | string | いいえ | 状態イベント(closeまたはreopen) |
labels | string | いいえ | カンマ区切りのラベル名リスト |
assigneeIds | array | いいえ | 割り当てるユーザーIDの配列 |
milestoneId | number | いいえ | 割り当てるマイルストーンID |
dueDate | string | いいえ | YYYY-MM-DD形式の期限日 |
confidential | boolean | いいえ | 課題が機密扱いかどうか |
| パラメータ | 型 | 説明 |
|---|
issue | object | 更新されたGitLab課題 |
GitLabプロジェクトから課題を削除する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
issueIid | number | はい | 課題内部ID(IID) |
| パラメータ | 型 | 説明 |
|---|
success | boolean | 課題が正常に削除されたかどうか |
GitLab課題にコメントを追加する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
issueIid | number | はい | 課題の内部ID(IID) |
body | string | はい | コメント本文(Markdown対応) |
| パラメータ | 型 | 説明 |
|---|
note | object | 作成されたコメント |
GitLabプロジェクトのマージリクエスト一覧を取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
state | string | いいえ | 状態によるフィルタリング(opened、closed、merged、all) |
labels | string | いいえ | カンマ区切りのラベル名リスト |
sourceBranch | string | いいえ | ソースブランチによるフィルタリング |
targetBranch | string | いいえ | ターゲットブランチによるフィルタリング |
orderBy | string | いいえ | 並べ替えフィールド(created_at、updated_at) |
sort | string | いいえ | 並べ替え方向(asc、desc) |
perPage | number | いいえ | ページあたりの結果数(デフォルト20、最大100) |
page | number | いいえ | ページネーションのページ番号 |
| パラメータ | 型 | 説明 |
|---|
mergeRequests | array | GitLabマージリクエストのリスト |
total | number | マージリクエストの総数 |
特定のGitLabマージリクエストの詳細を取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
mergeRequestIid | number | はい | マージリクエスト内部ID(IID) |
| パラメータ | 型 | 説明 |
|---|
mergeRequest | object | GitLabマージリクエストの詳細 |
GitLabプロジェクトに新しいマージリクエストを作成する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
sourceBranch | string | はい | ソースブランチ名 |
targetBranch | string | はい | ターゲットブランチ名 |
title | string | はい | マージリクエストのタイトル |
description | string | いいえ | マージリクエストの説明(Markdown対応) |
labels | string | いいえ | カンマ区切りのラベル名リスト |
assigneeIds | array | いいえ | 割り当てるユーザーIDの配列 |
milestoneId | number | いいえ | 割り当てるマイルストーンID |
removeSourceBranch | boolean | いいえ | マージ後にソースブランチを削除する |
squash | boolean | いいえ | マージ時にコミットをスカッシュする |
draft | boolean | いいえ | 下書き(作業中)としてマークする |
| パラメータ | 型 | 説明 |
|---|
mergeRequest | object | 作成されたGitLabマージリクエスト |
GitLabプロジェクトの既存のマージリクエストを更新する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
mergeRequestIid | number | はい | マージリクエスト内部ID(IID) |
title | string | いいえ | 新しいマージリクエストのタイトル |
description | string | いいえ | 新しいマージリクエストの説明 |
stateEvent | string | いいえ | 状態イベント(closeまたはreopen) |
labels | string | いいえ | カンマ区切りのラベル名リスト |
assigneeIds | array | いいえ | 割り当てるユーザーIDの配列 |
milestoneId | number | いいえ | 割り当てるマイルストーンID |
targetBranch | string | いいえ | 新しいターゲットブランチ |
removeSourceBranch | boolean | いいえ | マージ後にソースブランチを削除する |
squash | boolean | いいえ | マージ時にコミットをスカッシュする |
draft | boolean | いいえ | 下書き(作業中)としてマークする |
| パラメータ | 型 | 説明 |
|---|
mergeRequest | object | 更新されたGitLabマージリクエスト |
GitLabプロジェクトでマージリクエストをマージする
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
mergeRequestIid | number | はい | マージリクエスト内部ID(IID) |
mergeCommitMessage | string | いいえ | カスタムマージコミットメッセージ |
squashCommitMessage | string | いいえ | カスタムスカッシュコミットメッセージ |
squash | boolean | いいえ | マージ前にコミットをスカッシュする |
shouldRemoveSourceBranch | boolean | いいえ | マージ後にソースブランチを削除する |
mergeWhenPipelineSucceeds | boolean | いいえ | パイプラインが成功したらマージする |
| パラメータ | 型 | 説明 |
|---|
mergeRequest | object | マージされたGitLabマージリクエスト |
GitLabマージリクエストにコメントを追加する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
mergeRequestIid | number | はい | マージリクエスト内部ID(IID) |
body | string | はい | コメント本文(Markdown対応) |
| パラメータ | 型 | 説明 |
|---|
note | object | 作成されたコメント |
GitLabプロジェクト内のパイプラインを一覧表示する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
ref | string | いいえ | ref(ブランチまたはタグ)でフィルタリング |
status | string | いいえ | ステータスでフィルタリング(created, waiting_for_resource, preparing, pending, running, success, failed, canceled, skipped, manual, scheduled) |
orderBy | string | いいえ | フィールドで並べ替え(id, status, ref, updated_at, user_id) |
sort | string | いいえ | 並べ替え方向(asc, desc) |
perPage | number | いいえ | ページあたりの結果数(デフォルト20、最大100) |
page | number | いいえ | ページネーションのページ番号 |
| パラメータ | 型 | 説明 |
|---|
pipelines | array | GitLabパイプラインのリスト |
total | number | パイプラインの総数 |
特定のGitLabパイプラインの詳細を取得する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
pipelineId | number | はい | パイプラインID |
| パラメータ | 型 | 説明 |
|---|
pipeline | object | GitLabパイプラインの詳細 |
GitLabプロジェクトで新しいパイプラインをトリガーする
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
ref | string | はい | パイプラインを実行するブランチまたはタグ |
variables | array | いいえ | パイプラインの変数の配列(各変数はkey、value、およびオプションのvariable_typeを持つ) |
| パラメータ | 型 | 説明 |
|---|
pipeline | object | 作成されたGitLabパイプライン |
失敗したGitLabパイプラインを再試行する
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
pipelineId | number | はい | パイプラインID |
| パラメータ | 型 | 説明 |
|---|
pipeline | object | 再試行されたGitLabパイプライン |
実行中のGitLabパイプラインをキャンセルする
| パラメータ | 型 | 必須 | 説明 |
|---|
projectId | string | はい | プロジェクトIDまたはURLエンコードされたパス |
pipelineId | number | はい | パイプラインID |
| パラメータ | 型 | 説明 |
|---|
pipeline | object | キャンセルされたGitLabパイプライン |