GitHubアクションとページを使用してGitHubイベントデータを公開する方法

GitHubで作業するチームは、コラボレーションのためにイベントデータに依存しています。問題、プルリクエスト、コメントとして記録されたデータは、プロジェクトを理解するために不可欠になります。

GitHub Actionsが一般提供されているため、プログラムでGitHubイベントデータにアクセスしてリポジトリに保存することができます。データをリポジトリ自体の一部にすることは、GitHubの外部でデータを保存する方法です。また、GitHubPagesなどの前面のWebサイトでデータを紹介する機能も提供します。

そして、あなたが私のようであれば、GitHubの問題のコメントを素晴らしい90年代のゲストブックページに変えることができます。

使用法に関係なく、基本的な概念は同じです。アクションを使用して、1つのワークフローファイルでGitHubイベントデータにアクセス、保存、表示できます。プロセスを説明するために、ゲストブックを際立たせるワークフローコードを紹介します。

ワークフローのトリガー方法など、GitHubアクションの概要については、「GitHubアクションを使用したツールに依存しない軽量のCI/CDフロー」を参照してください。

GitHubイベントデータへのアクセス

アクションワークフローは、いくつかのデフォルトの環境変数がある環境で実行されます。イベントデータなど、便利な情報がたくさんここにあります。イベントデータにアクセスする最も完全な方法は、 $ GITHUB_EVENT_PATHを使用することです。 変数、完全なJSONイベントペイロードを含むファイルのパス。

展開されたパスは、 /home/runner/work/_temp/_github_workflow/event.jsonのようになります。 そのデータはそのwebhookイベントに対応しています。 Webhookイベントデータのドキュメントは、GitHubRESTAPIのイベントタイプとペイロードにあります。 JSONデータをワークフロー環境で利用できるようにするには、 jqなどのツールを使用できます。 イベントデータを解析して環境変数に入れます。

以下では、問題コメントイベントからコメントIDを取得します：

ID="$(jq '.comment.id' $GITHUB_EVENT_PATH)"

ほとんどのイベントデータは、 github.eventからも入手できます。 JSONを解析する必要のないコンテキスト変数。同じコメントIDを取得する以下の例のように、フィールドにはドット表記を使用してアクセスします。

ID=${{ github.event.comment.id }}

ゲストブックでは、ユーザーのハンドルと日付と時刻を含むエントリを表示したいと思います。このイベントデータは次のようにキャプチャできます：

AUTHOR=${{ github.event.comment.user.login }}
DATE=${{ github.event.comment.created_at }}

シェル変数はデータにアクセスするのに便利ですが、一時的なものです。ワークフロー環境は実行ごとに新しく作成され、1つのステップで設定されたシェル変数でさえ他のステップに保持されません。キャプチャされたデータを永続化するには、アーティファクトを使用するか、リポジトリにコミットするかの2つのオプションがあります。

イベントデータの保存：アーティファクトの使用

アーティファクトを使用すると、リポジトリにコミットせずにワークフロージョブ間でデータを永続化できます。これは、たとえば、データをより永続的な場所に配置する前に、データを変換または組み込む場合に便利です。次の理由により、ワークフロージョブ間でデータを保持する必要があります。

ワークフローの各ジョブは、仮想環境の新しいインスタンスで実行されます。ジョブが完了すると、ランナーは終了し、仮想環境のインスタンスを削除します。 （アーティファクトを使用したワークフローデータの永続化）

アーティファクトの使用を支援する2つのアクション： upload-artifact およびdownload-artifact 。これらのアクションを使用して、同じワークフロー内の他のジョブでファイルを使用できるようにすることができます。完全な例については、ワークフロー内のジョブ間でのデータの受け渡しを参照してください。

upload-artifact アクションのaction.yml キーワードの説明が含まれています。アップロードされたファイルは.zipに保存されます フォーマット。同じワークフロー実行の別のジョブで、 download-artifactを使用できます 別のステップでデータを利用するためのアクション。

ワークフロー実行ページのリポジトリの[アクション]タブでアーカイブを手動でダウンロードすることもできます。

生成されたアーティファクトはワークフロー環境でのみライブであるため、ジョブ間でワークフローデータを永続化しても、リポジトリファイルは変更されません。

個人的には、シェル環境での作業に慣れているため、アーティファクトの使用例は限られていますが、アーティファクトは言うまでもありません。ジョブ間でデータを渡すだけでなく、 .zipの作成にも役立つ可能性があります。 たとえば、テスト出力データのアーカイブをフォーマットします。ゲストブックの例の場合、1つのジョブで必要なすべての手順を実行するだけで、ジョブ間でデータを渡す必要がなくなりました。

イベントデータの保存：ワークフローファイルをリポジトリにプッシュ

ワークフローでキャプチャされたデータをリポジトリ自体に保存するには、このデータをGitリポジトリに追加してプッシュする必要があります。ワークフローでこれを行うには、データを使用して新しいファイルを作成するか、シェルコマンドを使用して既存のファイルにデータを追加します。

- uses: actions/checkout@master
  with:
    fetch-depth: 1

- name: Turn comment into file
  run: |
    ID=${{ github.event.comment.id }}
    AUTHOR=${{ github.event.comment.user.login }}
    DATE=${{ github.event.comment.created_at }}
    COMMENT=$(echo "${{ github.event.comment.body }}")
    NO_TAGS=${COMMENT//[<>]/\`}
    FOLDER=comments

    printf '%b\n' "<div class=\"comment\"><p>${AUTHOR} says:</p><p>${NO_TAGS//$'\n'/\<\/p\>\<p\>}</p><p>${DATE}</p></div>\r\n" > ${FOLDER}/${ID}.html

<div class="comment">
  <p>victoriadrake says:</p>
  <p>This is a comment!</p>
  <p>2019-11-04T00:28:36Z</p>
</div>

- name: Assemble page
  run: |
    cat header.html > index.html
    find comments/ -name "*.html" | sort -r | xargs -I % cat % >> index.html
    cat footer.html >> index.html

- name: Push changes to repo
  run: |
    REMOTE=https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
    git config user.email "${{ github.actor }}@users.noreply.github.com"
    git config user.name "${{ github.actor }}"

    git pull ${REMOTE}
    git checkout master
    git add .
    git status
    git commit -am "Add new comment"
    git push ${REMOTE} master

- name: Run Makefile
  env:
    TOKEN: ${{ secrets.GITHUB_TOKEN }}
  run: make all