Gitlab Merge Request Builderを適用する #GitLab

Gitlab Merge Request Builder Pluginは、GitlabにMergeRequestが作られたことを検出してジョブを実行するJenkinsプラグインです。

MRがマージされた後のソースコードをワークスペースに作成してからビルド（テスト）を実行できるため、マージ元ブランチだけに行うよりも精度の高いCIができます。

また、該当のMRのコメント欄に結果を投稿してくれる機能もあります。（このへんの魅力は後述のくりにっきさんを見るとわかりやすいです）

Reference

くりにっきさんで説明されていることは極力説明しません。

本記事では、くりにっきさんと本家のドキュメントを見比べながら試行した内容について説明します。

中途半端に日本語化されたJenkinsを元に書いたので、フル英語のJenkinsをお使いの皆様は適宜読み替えてください。ごめんなさい。

JenkinsとGitLab両方に設定を行います。

このドキュメント内では

と呼称します。

プロジェクトXのVisibility LevelがInternalまたはPublicになっていること
- Privateなリポジトリが相手だと動き出しませんでした。
ジョブXでGitLabからソースコードをフェッチしてくるときの認証は、GitLabのDeployKeyの仕組みを使って行われていること
- まあセキュアならなんでもいいとは思います
JenkinsへのGitlab Merge Request Builder Pluginの導入は済んでいること
Jenkinsのシステム設定画面で、Gitlabのホスト名の指定やアカウントやAPIキーの登録が済んでいること

以上。

Git
Repositories
- Repository URL: ${gitlabSourceRepository}
- Credentials: プロジェクトAでEnableにしたやつ
- Name: ${gitlabSourceName}
Branches to Build
- Branch Specifier: refs/remotes/${gitlabSourceName}/${gitlabSourceBranch}
Additional Behaviors: Merge Before Build
- Name of repository: origin
- Branch to merge to: ${gitlabTargetBranch}
- Merge Strategy: default
- Fast-forward mode: --no-ff(筆者の好みです。お好きにどうぞ。)

Gitlab Merge Requests Builder
- Gitlab Project Path: GroupX/ProjectX
- Crontab line: H/2 * * * *(筆者の好みです。お好きにどうぞ。)

お好きにどうぞ。

お好きにどうぞ。

通常、マージリクエストを検出した上で実行されたジョブの中では、${gitlabSourceBranch}や${gitlabTargetBranch}などの変数はマージリクエストから得られた情報によって解決されます。一方、任意のタイミングでビルドを実行したい場合には変数の解決ができません。

そんな場合は、「ビルドのパラメータ化」で下記の値を設定することで、任意のタイミングでのビルド実行ができます。

gitlabSourceNameは１つのリポジトリ内でMRを作っている場合はoriginですが、フォークしたブランチからマージリクエストを作成した場合にどんな名前になるのか追いきれませんでした。（誰か教えて）

ほぼ本家のREADMEのつまみ食いみたいな感じになりました。プロジェクトのVisibility LevelがInternalまたはPublicじゃないと動かないのはしばらくハマりましたね。。。

それにしても、botがMergeRequestのコメント欄で動き出すと楽しいですね！　Let's自動化！！！