GitHub Actions を使用した継続的インテグレーションのセットアップ

ドキュメント 開発者ガイド
,
1

:mag: 概要

Discourse 用の堅牢な拡張機能を作成する際は、プラグインやテーマコンポーネントに継続的インテグレーション（CI）を組み込むことが賢明です。これにより、早期にエラーを検出し、コード内のバグ発生リスクを軽減できます。

GitHub Actions を使用して CI ワークフローを設定し、ビルドとテストを自動化する方法は、Discourse チームがすべてのコンポーネントで採用しているアプローチであり、皆様にも同様の対応をお勧めします。

:gear: 設定方法

GitHub Actions による自動検出ワークフローを追加するには、リポジトリのルートディレクトリに .github/workflows フォルダを作成する必要があります。

workflows フォルダ内では、GitHub Actions が実行する一連の自動化を定義できます。例えば、リンティングやテスト用の .yml ファイルなどが該当します。

プラグイン と テーマコンポーネント の両方に対応したテンプレートワークフローを作成しましたので、ご活用ください。これらは、以下の「再利用可能なワークフロー」定義に接続されています：こちら。

テンプレートとなるスケルトンリポジトリでは、GitHub 上で このテンプレートを使用 ボタンをクリックすることで、テンプレートに基づいたプラグインまたはテーマコンポーネントのリポジトリを作成できます。

あるいは、既にプロジェクトをお持ちでワークフローを追加したい場合は、必要なワークフローファイルをリポジトリの .github/workflows/ フォルダにコピーするだけで構いません：

:electric_plug: プラグイン: discourse-plugin.yml

:jigsaw: テーマおよびテーマコンポーネント: discourse-theme.yml

:point_up: これらのテンプレートは、再利用可能なワークフローの特定のメジャーバージョンに固定されています。ワークフローに対する軽微な改善は、自動的にテーマやプラグインに反映されます。破壊的変更（例：新しいリンターの導入など）が発生する場合は、再利用可能なワークフローのメジャーバージョンを上げますので、ワークフローを新しいバージョンを指すように更新する必要があります。

:tada: 準備完了です！リポジトリにコミットを行うか、プルリクエスト（PR）を作成するだけで、GitHub Actions がワークフローを自動的に検出し、ジョブの実行を開始します。

GitHub Actions は各テストの詳細を表示し、実行後にテストが成功した場合は :white_check_mark:、失敗した場合は :x: を示します。

テストが失敗した場合は、詳細をクリックすることで失敗の原因に関する情報が得られ、コードのどこに問題があり、何を修正すべきかの手がかりが得られる場合があります。

例を表示

example failure
example failure2192×1018 250 KB

:white_check_mark: 独自のテストの追加

プラグインおよびコンポーネントのテストを効果的に機能させるためには、プラグインやテーマコンポーネントに対してテストを記述することが重要です。

EmberJS を用いたフロントエンドテストの書き方については、以下をご覧ください：

Rails を用いた RSpec テストの書き方については、以下をご覧ください：

:bulb: 例

参考までに、堅牢なテストが統合されているプラグインおよびテーマコンポーネントの例をいくつか紹介します：

プラグイン / コンポーネント クライアントサイドテスト サーバーサイドテスト
Assign :link: フォルダを表示 :link: フォルダを表示
Calendar :link: フォルダを表示 :link: フォルダを表示
Reactions :link: フォルダを表示 :link: フォルダを表示
Right Sidebar Blocks :link: フォルダを表示
Tag Icons :link: フォルダを表示
Table Builder :link: フォルダを表示

このドキュメントはバージョン管理されています。変更を提案する場合は GitHub でお寄せください。

「いいね！」 15
How could a CI workflow for unofficial plugins be implemented?
Unexpected error in Discourse Plugin CI
6

GitHub - discourse/discourse-theme-skeleton: Template for Discourse themes を明示的に言及し、それらのファイルの変更に注意するためにウォッチする必要があることを指摘するとよいでしょう。

「いいね！」 4
7

再利用可能なワークフローがマージされ、テンプレートから作成された新しいリポジトリがテンプレートリポジトリから直接ワークフローを使用するようになれば、この部分は関連性が低くなることが期待されます。

「いいね！」 2
8

@pfaffman、@Simon_Manning、ありがとうございます。良い点ですね。OPをそれに応じて更新しました。

「いいね！」 4
9

OPを更新し、新しい「再利用可能なワークフロー」の使用方法に関する説明を追加しました。ワークフロー定義に加えるマイナーな変更は、手作業なしでテーマ/プラグインに自動的に適用できるようになります。

「いいね！」 3
10

最新の tests-passed および stable に対してプラグインをテストするために、何か特別なことをする必要がありますか？

「いいね！」 1
11

プラグインスケルトンワークフローは以下を使用しており、これはデフォルトのブランチ、つまりmainに対してテストされると思います。再利用可能なワークフローにはオプションのcore_ref入力があり、私の知る限り、それがない場合、discourse/discourseリポジトリのデフォルトブランチがチェックアウトされます。

jobs:
  ci:
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1

これが実際にmainに限定してテストされるかどうかは断言できませんが、もしそうであれば、テストしたい各リファレンスに対して1回実行するマトリックス戦略を追加できます。

jobs:
  ci:
    strategy:
      matrix:
        target: [tests-passed, stable]
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1
    with:
      core_ref: ${{ matrix.target }}
「いいね！」 3
12

はい、これで大丈夫でしょう。または、マトリックスを使用せずに、2つのジョブを手動で記述することもできます。

name: Discourse Plugin

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  ci:
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1

  ci-stable:
    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1
    with:
      core_ref: stable

ただし、注意点として、これらのジョブは .discourse-compatiblity をチェックしません。そのため、このファイルを使用せず、同時に main と stable の両方との互換性が必要なプラグインでのみ、これを行う価値があります。

CDCK のすべての公開テーマ/プラグインでは、ディスコース互換性エントリを追加して、すべての安定リリースでそれらを「フリーズ」します。そうすれば、開発中に安定互換性を気にする必要がなくなります。

「いいね！」 5
13

お二人ともありがとうございます。

ええ、おそらくそれが最も簡単なアプローチでしょう。唯一の欠点は、機能（および新しいバグ修正）が遅れる可能性があることです。

「いいね！」 2