第25回/RedmineプラグインのGitHub Actionsの調査

目的・背景:

汎用的に使えるRedmineプラグインのGitHub Actionsを作成して、Redmineプラグインのテストを自動化し、プラグインの開発・メンテナンスを効率的にできるようにしたい。

要件:

RedmineプラグインのGitHubリポジトリに設定することで、

Redmineプラグインのテストの自動実行が可能

Redmineプラグインがサポートする環境毎に組み合わせたテストが可能

Redmine: 4.2, 5.0, master(trunk)

Ruby: 2.6, 2.7, 3.0, 3.1

DB:

PostgreSQL: 10, 11, 12, 13, 14, (15)

PostGIS: 2.5, 3.0, 3.1, 3.2, (3.3)

MySQL: 5.7, 8.0

SQLite: - (OSバージョン)

なるべく実行時間を減らしたい

やること:

GitHub上で公開されているRedmine関連のGitHub Actions事例の調査

パッチ会リポジトリ

特徴:

以下のコードでキャッシュを流用するようにして高速化を図っている

code:yml

with:

path: vendor/bundle

key: ${{ matrix.ruby }}-postgres-${{ hashFiles('**/Gemfile') }}

restore-keys: |

${{ matrix.ruby }}-postgres-

${{ matrix.ruby }}-

postgres/mysqlはサービス+Dockerイメージ利用、sqliteはrubyのDockerイメージをそのまま利用し、サービスはなし

Redmineプラグイン関連

特徴:

DBはpostgresのみ

Redmineの最新パッチバージョン、master用にワークフローファイルを別分け

コンテナにrubyイメージを利用

code:yaml

container:

image: ruby:${{ matrix.ruby }}

ネイティブのGemビルド向きではない？

特徴:

DBはPostgreSQL・MySQLのみで、マトリックスは全組み合わせを定義

特徴:

DBは全て(sqlite3, mysql, postgres)だが、バージョンは固定

コンテナにrubyイメージを利用

特徴:

DBはsqlite3のみ

マトリックスは文字列で、RubyバージョンとGitHub上のRedmine/Redmicaリポジトリパスとタグバージョン

Zeitwerkチェックがある

特徴:

DBはpostgres, mysqlのみで、バージョンは固定

特徴:

システム(Selenium)テストが含まれている

その他、AgilewareさんのCircle CIのRedmineプラグイン用環境 (石川さんより)

実装方針

GTT関連プラグインでは、DBバージョン周りで特殊な要件が必要なこともあり、パッチ会のリポジトリを参考に実装を進め中

database設定ファイルについては、同じフォルダ内に含める予定

ファイル数が多いと、複数のGitHubリポジトリで扱う際に、処理が煩雑になるかも

複数のGitHubリポジトリ間でGitHub Actionsを共有する方法:

code:yml

production:

development:

test:

code:yaml

sqlite3: &sqlite3

adapter: sqlite3

pool: 5

timeout: 5000

database: db/redmine.sqlite3

mysql: &mysql

adapter: mysql2

encoding: utf8

postgres: &postgres

adapter: postgresql

encoding: utf8

development:

test:

production:

=> database設定ファイルについては、AgilewareさんのCircle CIコードを参考に、test環境のみヒアドキュメントで記載する方向に

code:yaml

cat \<<-'EOF' > database.yml

test:

adapter: postgresql

database: circle_test

host: 127.0.0.1

username: postgres

password: postgres

EOF

実装

下記の個人(sanak)アカウントのPRで動作確認中

code:text

Run ruby/setup-ruby@v1

Error: Error: Unknown version 2.6 for ruby on ubuntu-22.04

available versions for ruby on ubuntu-22.04: 3.1.0, 3.1.1, 3.1.2, 3.2.0-preview1, head, debug

Make sure you use the latest version of the action with - uses: ruby/setup-ruby@v1

=> OKそうなので、こちらを採用します。

最終

社内レビューですが、以下のPRで取り込まれました。

10/29以降追記

システムテストとコアテスト(いずれもコメントアウト)を追加