リポジトリサブモジュールAPI

リポジトリ内の既存のサブモジュール参照を更新

ワークフローによっては、特に自動化されたワークフローでは、サブモジュールの参照を更新してそのサブモジュールを使う他のプロジェクトを最新の状態に保つと便利なことがあります。このエンドポイントを使うと、特定のブランチのGit サブモジュール参照を更新することができます。

PUT /projects/:id/repository/submodules/:submodule
属性種類必須説明
id整数/文字列yes認証ユーザーが所有するプロジェクトのIDまたはURLエンコードされたパス
submodule文字列です。yesサブモジュールへの URL エンコードされたフルパス。例えばlib%2Fclass%2Erb
branch文字列です。yesコミットするブランチの名前
commit_sha文字列です。yesフルコミットSHAでサブモジュールを次のように更新します。
commit_message文字列です。いいえコミット・メッセージ。メッセージがない場合、デフォルトが設定されます。
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/submodules/lib%2Fmodules%2Fexample" \
--data "branch=master&commit_sha=3ddec28ea23acc5caa5d8331a6ecb2a65fc03e88&commit_message=Update submodule reference"

応答例

{
  "id": "ed899a2f4b50b4370feeea94676502b42383c746",
  "short_id": "ed899a2f4b5",
  "title": "Updated submodule example_submodule with oid 3ddec28ea23acc5caa5d8331a6ecb2a65fc03e88",
  "author_name": "Dmitriy Zaporozhets",
  "author_email": "dzaporozhets@sphereconsultinginc.com",
  "committer_name": "Dmitriy Zaporozhets",
  "committer_email": "dzaporozhets@sphereconsultinginc.com",
  "created_at": "2018-09-20T09:26:24.000-07:00",
  "message": "Updated submodule example_submodule with oid 3ddec28ea23acc5caa5d8331a6ecb2a65fc03e88",
  "parent_ids": [
    "ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
  ],
  "committed_date": "2018-09-20T09:26:24.000-07:00",
  "authored_date": "2018-09-20T09:26:24.000-07:00",
  "status": null
}