Jira Cloudの自動化機能でConfluenceのページを作成する

J. Sakurai

Jiraでは自動化機能 を利用することで非常に柔軟なルールを作成できます。また[Webhookを送信]アクションを利用することで他のアプリケーションとも連携することができます。

今回はJira Cloudの自動化機能を利用して「Jiraの課題がクローズされた時にConfluenceにページを作成する」というルールの作成方法をご紹介します。

イメージとしては次のような課題がクローズされた時に

次のようなConfluenceのページを作成します。

■ 手順

1.  下準備
   1. API トークンを作成する
   2.  "$EMAIL_ADDRESS:$API_TOKEN" の形式でBase64エンコードを行う
2. 自動化ルールの作成
   1. 任意のプロジェクトを開き[プロジェクト設定]-[Project automation]を選択する
   2. 右上の[ルールを作成]を選択する
   3. トリガーに[移行済みの課題]を選択する
   4. To statusに任意のステータスを選択する。今回は[クローズ]を選択しました。
      • 
   5. [保存]を選択する
   6. [新しいアクション]を選択し[Webhookを送信]を選択する
   7. 次の通り情報を入力する
      • 
      • Webhook URL : https://<your site name>/wiki/rest/api/content
      • ヘッダー
        • Accept : application/json
        • Content-Type : application/json
        • Authorization : Authorization: Basic <下準備で出力した認証情報>
      • カスタムデータ※<スペースキー>を任意のものに変更してください

        • {
            "title": "{{issue.key}} : {{issue.summary}}",
            "type": "page",
            "space": {
              "key": "<スペースキー>"
            },
            "status": "current",
            "body": {
              "storage": {
                "value": "<h2>説明</h2>{{issue.description.htmlEncode}}<br/><h2>コメント</h2>{{#issue.comments}}<p>Comment by: {{author. displayName}} at: {{created}}</p><p>{{body.htmlEncode}}</p><hr />{{/}}",
                "representation": "storage"
              }
            },
            "metadata": {
            	"properties":{
          	  	"editor": {
          	  		"value": "v2"
          	  	}
            	}
            }
          }
          

   8. [保存]を選択しルール名を入力し[turn it on]を選択する

いかがでしたでしょうか？

今回利用したConfluence CloudのAPIは次のものになります。

• The Confluence Cloud REST API

自動化機能のスマートバリューを使用して連携する内容をカスタマイズすることもできます。スマートバリューについて宜しければ次のドキュメントをご覧ください。

• スマート バリューとは

■ 制約事項

• 今回のルールではページの作成のみを行います。そのため例えばクローズ→再オープン→クローズという操作を行なった場合にページの内容は更新されません。