Skip to content

README-jp.md

Latest commit

 

History

History
71 lines (46 loc) · 2.57 KB

README-jp.md

File metadata and controls

71 lines (46 loc) · 2.57 KB

Github Api Wrapper for Jenkins

このライブラリはJenkinsからgithubの操作を行うための GitHub API for Java の薄いラッパーです。

主なできること

GitHub API for Java の機能のうち、Jenkinsでよく使う機能を重点的に実装しています。 もし、実装以上に機能が必要であれば、ライブラリをカスタムするか、rawプロパティでGHObjectを取得してください。 (PullRequest出してもいいのよ)

詳しくは API Documentへ

  • リポジトリ
    • リポジトリの作成 / 削除
    • ラベルの作成 / 削除
    • コミット間の差分を取得
  • PullRequest
    • 作成
    • マージ
    • コメント

その他

設定

System Configuration

  1. GitHub > GitHub Servers

Github Serverを追加する。 詳しくはGitHub Plugin

  1. Global Pipeline Libraries

このリポジトリのURLまたはフォークしたリポジトリを設定する。

  1. Jenkinsfileを書く
  2. https://github.com/Marimoiro/jenkins-github-api-wrapper にStarをつける

Samples について

[samples/Info.groovy] に操作するリポジトリの設定が記述されています。 お試しする場合は、これを自分がフォークしたリポジトリに書き換えてください。

制限

CPS対応について

すべてのインスタンスはできれば、1つのscriptブロック内で使用することをおすすめします。 スコープを乗り越えることは出来ますが、テストは不十分です。

機能が足らない場合

ほとんどすべてのクラスは(getRaw)メンバでバックエンドのGitHub API for Java のオブジェクトにアクセスできます。

または、このライブラリはとても簡単なコードになっているので実装して、PullRequestを出すことも可能です。

このライブラリがアクセスできる範囲

githubに対して正当なアクセス権があるとこのライブラリはあなたがGitHubに対して行えるすべてのことができてしまうので、気をつけてください。 基本的にはLoad implicitlyにチェックはせずに必要なジョブでだけ読み込む形がいいと思います。

ライセンス

LICENSE

Starは押してほしいな

ライセンスはMITですが、このライブラリを使用する場合はStarを押してください。 僕が幸せになります。