DrupalからGitHubのActionsを実行するモジュールを作成しました。

概要

DrupalからGitHubのActionsを実行するモジュールを作成しました。

https://github.com/nakamura196/Drupal-module-github_webhook

以下、使い方について説明します。

使い方

設定

モジュールのインストール後、以下にアクセスします。

/admin/config/github_webhook

以下のような画面に遷移します。

大きく、RespositoriesとTrigger Webhookに分かれています。

まず、RespositoriesのRepository 1にGitHub Actionsの実行対象のリポジトリの情報を入力します。Add repositoryやRemove repositoryから、リポジトリの追加と削除を行うことができます。

Event Typeには、GitHub Actions側で設定した値を入力します。初期値のwebhookは、以下のようなActionsを想定しています。

name: Deploy to GitHub Pages

on:
  push:
    branches: ["main"]
  workflow_dispatch:

  repository_dispatch:
    types: [webhook]

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
...

設定後、画面下部の送信ボタンを押して保存します。

実行

実行対象のリポジトリを選択して、Trigger Webhookボタンを押します。

以下のように、triggered successfullyと表示されれば成功です。

参考

今回は独自に作成したモジュールを紹介しましたが、pipedreamを使った実行方法を以下で紹介しています。

https://zenn.dev/nakamura196/articles/08a8b80d5bf9f5

こちらも参考になりましたら幸いです。

まとめ

改善の余地は多々ありますが、DrupalをヘッドレスCMSとして使用する際など、参考になりましたら幸いです。