Jenkinsのジョブ(プロジェクト)の名前付け規則の提案
Jenkinsのジョブの名前は大事です。
どれくらい大事かというと、多分プログラムのpublicメソッド名より大事です。
なんでかというと、
- Jenkinsってプログラマ以外も使ったりするから名前で意味が分かってほしい
- っていうか手動でも動かしたりもするんだからわからないと困る
- 名前がJenkinsのUIに直接表示され影響を与える
からです。
で、Jenkinsの名前をどう付けるかはなかなか迷いどころで全然うまくいかないです。
が、ある程度こうするればそこそこよくなるよ…というのはわかってきたのでチョットだけTips的なものを書きます。
主にUIとしての見易さを重視した提案です。
ちなみに、Jenkinsにはフォルダとビューがあるのでちゃんと使いましょう。
固めたいジョブは先頭の単語を同じにする
Jenkinsのジョブは並び方がcase insensitiveのabc順になります。
なので固めたいジョブは先頭の単語が一致していれば固まっていくことになります。
ですから例えば
- BuildServer-develop
- BuildServer-staging
にするか
- ServerBuild-develop
- ServerBuild-staging
にするか悩んだときは
Serverなジョブで固めたいかBuildなジョブで固めたいかで決めるといいと思います。
勿論developで固めたいならdevelopが先ですね。
_より-の方がいい
これ単純にchromeのアドレスバーで-区切りだとそこで一単語になるのに、_だとそうならないからですね。
なのでurlを直接打ち込むようになると少し楽になります。
日本語を使うかどうか
手動でビルドする部分については特に非プログラマが使う部分に関しては使ってもいいかも
フォルダとビューを使え
命名規則でもないんですけれど、超重要だと思うので書きます。
フォルダはJenkins2.0からプリセットに入ったジョブのフォルダです。(そのままだけど!)
ジョブとして作成します。
サーバー関連ジョブなんかでまとめたり
- サーバー関連
- ビルド
- ドキュメント
のような形でまとめると多分幸せになります。
ちなみにフォルダの名前を変えるとworkspaceも変わるので注意
ビューはそこまでするまででもないジョブをまとめるのが多分いいですかね?
ビューにはいくつかプラグインもあります。
プロジェクトの規模にもよりますがかなり細かくフォルダ分けしちゃってもいいかも?