GitHub GraphQL API を利用してPull requests のコメントを抽出してみた

こおりやまです

以前、こちらのブログでGitHub GraphQL APIをさわってどのような情報を取得できるのか確認していたのですが、Pull requests のコメント取得が必要になりGoogle Apps Script(GAS)から呼び出しスプレッドシートに出力してみました。

GitHub GraphQL API をさわってみた

まずは GraphQL API Explorer を利用して必要な情報が取得できるようQuery を検討します。

実行するクエリを作成したら、スクリプトを書いていきます。

書いたコードはこんな感じ

(設定情報は環境に合わせて設定して下さい)

/***********************************************
 * 設定情報
 ***********************************************/
var ACCESS\_TOKEN = "ACCESS\_TOKEN";  
var ENDPOINT = "[https://api.github.com/graphql]";  
var REPOSITORY\_NAME = "NAME";  
var REPOSITORY\_OWNER = "OWNER";  
var LABELS = "LABEL";

/***********************************************
 * GitHubからPRの一覧取得
***********************************************/
function getPullRequests(endCursor) {
  // 次ページの検索情報  
  var pageCursor = "";  
  if(endCursor != ""){  
    // 次ページを検索させるための情報  
    pageCursor = ",after: \\"" + endCursor + "\\""  
  }
  // 作成日降順、ラベルを特定  
  var query = '\\  
  {\\  
    repository(name: "' + REPOSITORY\_NAME + '", owner: "' + REPOSITORY\_OWNER + '") {\\  
       pullRequests(first: 50' + pageCursor + ', labels: "' + LABELS + '", orderBy: {field: CREATED\_AT, direction: DESC}) {\\  
         edges {\\  
          node {\\  
            url\\  
            title\\  
            closed\\  
            createdAt\\  
            author {\\  
              login\\  
            }\\  
            reviews(first: 20) {\\  
              nodes {\\  
                bodyText\\  
                author {\\  
                  login\\  
                }\\  
              }\\  
            }\\  
          }\\  
        }\\  
        pageInfo {\\  
            hasNextPage\\  
            endCursor\\  
        }\\  
      }\\  
    }\\  
  }';

   var options = {  
    'method' : 'post',  
    'contentType' : 'application/json',  
    'headers' : {  
      'Authorization' : 'Bearer ' +  ACCESS\_TOKEN  
     },  
    'payload' : JSON.stringify({query:query})  
  };
  
  // fetch 情報を取得  
  var response = UrlFetchApp.fetch(ENDPOINT, options);
  // Json形式で返却  
  return JSON.parse(response.getContentText());;  
}

/***********************************************
 * main
 * GitHubからPRの一覧取得
***********************************************/
function main(){  
    Logger.log("開始");

    var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('シート1');
    var iRow = 2;  
    var nextPageCursor = ""; // 次ページのカーソル情報

    do{  
        var allDocuments = getPullRequests(nextPageCursor);  
        var edges = allDocuments.data.repository.pullRequests.edges;

        edges.forEach(function(edge){  
          // Logger.log(edge);  
          //出力前にクリア  
          sheet.getRange(iRow+':'+iRow).clear();

          sheet.getRange(iRow, 1).setValue(edge.node.url);  
          sheet.getRange(iRow, 2).setValue(edge.node.author.login);  
          sheet.getRange(iRow, 3).setValue(edge.node.title);

         // コメント情報を出力する  
          var iCol = 4;  
          var reviews = edge.node.reviews.nodes;  
          reviews.forEach(function(review){  
            if(review.bodyText!=""){  
              var login = review.author.login;  
              sheet.getRange(iRow, iCol).setValue('@'+login + '\\n' + review.bodyText); }  
              iCol++;  
            }  
          }); iRow++;  
        });  
        // 次ページがあるか、最終行のカーソル情報を取得  
        nextPageCursor = allDocuments.data.repository.pullRequests.pageInfo.endCursor  
        var hasNextPage = allDocuments.data.repository.pullRequests.pageInfo.hasNextPage  
        Logger.log("行:" + (iRow-2) + ' endCursor:' + nextPageCursor + ' hasNextPage:' + hasNextPage);
        
    // 次ページがなくなるまでループ  
    }while(hasNextPage === true)

    Logger.log("終了");  
}

一度に取得する行数を first: 50 で設定しておりページングさせるところで少し悩みましたが、以下のページを参考にして実装しています。

https://graphql.org/learn/pagination/

pullRequests にある paheInfo 情報を取得するようQueryを設定して、取得したendCursor 情報を取得時の after に設定することで次ページの情報が取得できるようになります。

pageInfo {  
    hasNextPage  
    endCursor  
}

設定したコードを実行すると以下のフォーマットで情報が取得できます。

1_EsClzg7aH6gT2eWb7yXfPQ
今回はコメント情報だけ必要だったのでQueryは上記になっていますが、レビューコメントなども取得できる所までは確認しており、必要になったらまたブログで書こうかと思います。

ではでは