GitHub Actions を使用して継続的インテグレーションを設定する

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

:mag: 概要

Discourse 用の堅牢な拡張機能を構築するには、プラグインまたはテーマコンポーネントに継続的インテグレーション (CI) を組み込むのが賢明です。これにより、エラーを早期に検出し、コードにバグが発生する可能性を低減できます。

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

:gear: セットアップ方法

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

workflows フォルダ内には、GitHub Actions が実行する必要がある自動化処理のセットを定義できます。例えば、リンティングやテスト用の .yml ファイルなどが挙げられます。

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

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

あるいは、すでにプロジェクトがあり、そこにワークフローを追加したい場合は、関連するワークフローをリポジトリの .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 71.8 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