Share
Embed
Transcript
104 slides
-
充実していると思う理由 Drupalコミュニティが活発 Core だけではなく、Contribモジュールが多いのは貢献する人が多い 貢献する人が多い → 新規機能追加やメンテナンスが行われやすい 10年前と比べて2025年現在、(英語ですが)ドキュメントが豊富 コミュニティが意識的に育ててくれたドキュメントがある アクイア認定試験(Acquia
Certification) が体系的にDrupalを知ること ができる [1] https://www.acquia.com/jp/support/training-certification/acquia-certification 6 -
セキュリティチームの存在 セキュリティチーム が存在し、CoreだけでなくContribモジュー ルもチェックする仕組みがある 通常だと日本時間 木曜早朝に通知あり セキュリティ通知の受け取り方 drupal.orgのアカウントを作成 My account
の Edit タブ > My newsletters Security announcements にチェックをつけて保存 [1] https://www.drupal.org/security 7 -
リリーススケジュールが提示されている Coreに関してはアップグレード時の修正期間が考慮されたリリース サイクルが提示されている 全ての変更はissuesに存在し、Coreの大きな変更はチェンジレコ ードが存在する メジャーアップデートチェック用モジュールが存在し、アップデー トに手厚い [1] https://www.drupal.org/about/core/policies/core-release-cycles/schedule [2]
https://www.drupal.org/about/core/policies/core-release-cycles/release-process-overview [3] https://www.drupal.org/list-changes/drupal [4] https://www.drupal.org/project/upgrade_status 8 -
セマンティックバージョニング バージョン番号を MAJOR . MINOR . PATCH で表すルール MAJOR(メジャー): 後方互換性を壊す変更
10 → 11 MINOR(マイナー): 後方互換性を保ったまま新機能を追加 10.2 → 10.3 PATCH(パッチ) バグ修正やセキュリティ修正(10.2.5 → 10.2.6) 13 -
Drupal Core リリースの大枠 メジャーバージョンのリリース ・・・ 2年に1回 (偶数年) マイナーバージョンのリリース ・・・ 半年に1回
(6月, 12月) 新マイナーバージョンリリースされると、2つ前のバージョンがEOL [1] https://www.drupal.org/about/core/policies/core-release-cycles/release-process-overview 14 -
リリース参考 例: 2025/11/16 現在、サポートバージョン 10系 ・・・ 10.4, 10.5 11系 ・・・
11.1, 11.2 10.6 と 11.3 がリリースされたら、10.4 と 11.1 は EOL 15 -
Upgrade Status モジュール Upgrade Status はDrupalに関するメジャーアップデートができる かどうか判定してくれるモジュール このモジュールを入れてNG項目を解消した上で、本格的なアップデー ト作業をすることをおすすめします [1]
https://www.drupal.org/project/upgrade_status 20 -
つづき 数は少ない・期限が迫ってきている場合、対処してアップデートす る issueのパッチを適用する dev版コミットID指定で導入 composer-drupal-lenientプラグイン でcomposerでバージョン依存チ ェックをスキップ [1] https://www.drupal.org/docs/develop/git/using-gitlab-to-contribute-to-drupal/core-version-compatibility-fixes-
for-modules-with-unmerged-changes#s-usethe-composer-drupal-lenientpackage 25 -
ローカル開発環境 DDEV 自由に壊して戻せる開発環境を持つとお試ししやすい 2025年の今、ローカル環境はDDEV がおすすめ Docker、Docker Composeベース アドオンが豊富、Docker Compose ライクにコンテナ追加も可能
MailPit でメール捕捉が可能 Composer、Node コマンドがコンテナ内で実行可能 ローカルマシンにPHP、Nodeインストールしなくていい [1] https://ddev.com/ 32 -
DDEVでのDrupalの環境作成 # composerでソース取得 composer create-project drupal/recommended-project my-project cd my-project #
DDEVセットアップ・スタート ddev config ddev start # 環境情報確認 ddev status Drupal公式: https://www.drupal.org/docs/getting-started/installing-drupal/install-drupal-using-ddev-for-local- development 34 -
.ddev/config.yaml サンプル name: drupal-example-2025 type: drupal11 docroot: ./docroot php_version: "8.4"
webserver_type: nginx-fpm xdebug_enabled: false additional_hostnames: [] additional_fqdns: [] database: type: mariadb version: "10.11" use_dns_when_possible: true composer_version: "2" web_environment: [] corepack_enable: true 35 -
DDEVの導入意義 環境差分を減らすことができる 差分 = バグに繋がりやすい 本番に近いミドルウェアを用意できる 複数人での開発環境をそろえやすくなる 標準構成なら定義ファイルは .ddev/config.yaml のみ
プロジェクトをGitで管理して開発者の環境をそろえることができる 36 -
Composer Composer とはPHPの依存管理ツール。 Drupal自体もさまざまなパッケージが組み合わさってアプリケーショ ンとして成り立っているため、Composerによる管理が必須。 Drupal CMSにあるパッケージマネージャー経由でモジュールをアッ プデートした時もComposerの管理下で更新される。 [1] https://getcomposer.org/
[2] https://www.drupal.org/docs/develop/using-composer 37 -
composer.json その1 repositories には、メインリポジトリ Packagist 以外から配信さ れているパッケージ元のURLを定義 "repositories": [ {
"type": "composer", "url": "https://packages.drupal.org/8" } ], 参考 https://github.com/drupal/recommended-project/blob/11.x/composer.json [1] https://packagist.org/ 39 -
composer.json その2 require は、追加したパッケージが存在 バージョン幅ありで指定可能 "require": { "composer/installers": "^2.3", "drupal/core-composer-scaffold":
"^11", "drupal/core-recipe-unpack": "^11", "drupal/core-project-message": "^11", "drupal/core-recommended": "^11" }, 40 -
再掲:セマンティックバージョニング バージョン番号を MAJOR.MINOR.PATCH で表すルール MAJOR(メジャー): 後方互換性を壊す変更 10 → 11 MINOR(マイナー):
後方互換性を保ったまま新機能を追加 10.2 → 10.3 PATCH(パッチ) バグ修正やセキュリティ修正(10.2.5 → 10.2.6) [1] https://semver.org/lang/ja/ [2] https://www.drupal.org/docs/getting-started/understanding-drupal/understanding-drupal-version-numbers 41 -
バージョン範囲指定 バージョンアップデートしたい時の挙動がバージョン先頭の ^ と ~ で変わることに注意 ^ (キャレット) 次のメジャー未満で更新 ^10.4.0
は、同じメジャー、マイナー/パッチバージョンが更新 composer update で 10.5系最新まで上がる可能性あり ~ (チルダ) : 同じマイナー、パッチバージョンだけ更新 ~10.4.0 は、10.4系内までバージョンアップ可能 composer update で 10.4系最新まで上がる可能性あり 42 -
バージョン指定 個人的おすすめ Drupal Core のパッケージ(drupal/core-から始まるパッケージ)は ~ をつけて管理。急なセキュリティによるバージョンアップが楽。 "require": { "drupal/core-composer-scaffold":
"~11.2.3", "drupal/core-recipe-unpack": "~11.2.3", "drupal/core-recommended": "~11.2.3", "drush/drush": "^13.6" }, Coreのセキュリティアップデート時 ddev composer update "drupal/core-*" 43 -
composer.json その3 require-dev には、本番環境に不要な開発ツールパッケージが存在 "require-dev": { "drupal/core-dev": "~11.2.3" }, conflict
には 追加を拒否するパッケージを指定 "conflict": { "drupal/drupal": "*" }, 44 -
composer 主なコマンド DDEV版 1 パッケージ追加 ddev composer require 'drupal/pathauto:^1.13' require-devに追加
ddev composer require --dev 'drupal/core-dev:~11.2.3' 45 -
composer 主なコマンド DDEV版 2 パッケージのアップデート ※パッケージ指定なしは全部アップデート ddev composer update "drupal/core-*"
composer.jsonを手動でメタデータ変更後のcomposer.lock更新 ddev composer update --lock 46 -
composer 主なコマンド DDEV版 3 composer.lock に基づくインストール dev版 ddev composer install
composer.lock に基づくインストール 本番向け ddev composer install --no-dev 47 -
drupal/core-composer-scaffold composer install、composer update などのパッケージ更新時に 動作するComposerプラグイン Composerパッケージは原則 vendor ディレクトリに配置されるた め、Drupalが想定しているファイル構成へ置き換えてくれる
ドキュメントルート (web、docroot) の中に index.php や coreデ ィレクトリを配置 49 -
core-composer-scaffold 設定値 "drupal-scaffold": { "locations": { "web-root": "docroot/" } },
"installer-paths": { "docroot/core": [ "type:drupal-core" ], "docroot/modules/contrib/{$name}": [ "type:drupal-module" ], 参考 https://www.drupal.org/docs/develop/using-composer/using-drupals-composer-scaffold 50 -
パッチ追加例 "patches": { "drupal/core": { "#3530597": "./patches/core/date-field-default-value.patch", } } >
参考: https://www.bulblub.com/2018/08/composer_patch_pulugin/ パッチファイルはURL参照も可能。 ただしGitLabのマージリクエストでの修正の場合、パッチファイルを ダウンロードした上で適用した方がいい。 52 -
Configuration Management とは 管理画面で設定したサイト構造や動作に関わる情報 = サイト構成 (Configuration) をファイル管理して、各環境で同期する機能 インフラ構成のコード化して管理・自動化する Infrastructure
as Code(IaC)に近い思想 [1] https://www.drupal.org/docs/administering-a-drupal-site/configuration-management 60 -
Configuration Management の流れ 1. エクスポート Drushコマンドで構成をYAMLファイルとして出力 2. Gitバージョン管理 YAMLファイルをGit管理 3.
インポート 各環境でインポート この手順で環境間の同期を実現する 62 -
Configuration Split Configuration Split モジュール はサイト構成の一部を分割して、 サブセットを作成できる メインのサイト構成セット + 有効化指定したサブセットでエクスポー
ト/インポートできる [1] https://www.drupal.org/project/config_split 66 -
Configuration Split 使い方 1. サブセットを作成する ローカル用、開発環境用、検証環境用、本番環境用など 2. settings.php に有効化するサブセットを指定する //
サンプル if (開発環境の場合) { $config['config_split.config_split.dev']['status'] = TRUE; } if (本番環境の場合) { $config['config_split.config_split.live']['status'] = TRUE; } 67 -
Configuration Split 使い方のポイント モジュールの有効化を環境ごとに分けたい場合、 メインは無効化 + サブで有効化 Database Logging は基本無効化
+ 開発環境用だけ有効化 サブセットのステータスはOFFで設定 サブセットのconfigにステータスがあるが無効化する 有効化は settings.php のみで指定する 69 -
drupal/core-dev パッケージ 静的解析、テストコード実行をしたいなら drupal/core-dev パッケージを導入すると簡単 ddev composer require --dev drupal/core-dev:~11.2.1
-W バージョンは drupal/core のバージョンと合わせる require-dev として扱う [1] https://packagist.org/packages/drupal/core-dev 76 -
PHP CodeSniffer とは コーディングスタンダードに沿って静的解析を実行しコードのクリー ンさと一貫性を維持するツール Drupalのコーディングスタンダード に沿ったルールセットが存在し drupal/core-devに内包されている [1] https://github.com/PHPCSStandards/PHP_CodeSniffer/
[2] https://www.drupal.org/docs/develop/standards [3] https://www.drupal.org/project/coder 77 -
PHP CodeSniffer セットアップ プロジェクトルートに phpcs.xml を作成 <?xml version="1.0" encoding="UTF-8"?> <ruleset
name="Custom"> <description>Drupal コーディング標準用の PHP_CodeSniffer 設定</description> <arg name="extensions" value="engine,inc,install,module,php,profile,test,theme,yml"/> <rule ref="Drupal"/> <file>docroot/modules/custom</file> <file>docroot/themes/custom</file> </ruleset> 実行 ddev exec phpcs 78 -
PHP CodeSniffer エラー例 FILE: /var/www/html/docroot/modules/custom/site_notice/tests/src/Unit/SiteNoticeBlockTest.php ------------------------------------------------------------------------------------------------------------------------------- FOUND 3 ERRORS AND
1 WARNING AFFECTING 14 LINES ------------------------------------------------------------------------------------------------------------------------------- 13 | ERROR | [x] Missing class doc comment 16 | ERROR | [x] Missing function doc comment 19 | ERROR | [x] Inline comments must end in full-stops, exclamation marks, question marks, colons, or closing parentheses 132 | WARNING | [ ] Line exceeds 80 characters; contains 83 characters ------------------------------------------------------------------------------------------------------------------------------- PHPCBF CAN FIX THE 3 MARKED SNIFF VIOLATIONS AUTOMATICALLY ------------------------------------------------------------------------------------------------------------------------------- Time: 63ms; Memory: 6MB Failed to execute command `phpcs`: exit status 2 79 -
PHPStan セットアップ プロジェクトルートに phpstan.neon を作成 parameters: phpVersion: 80300 # PHP8.3
level: 5 paths: - docroot/modules/custom ignoreErrors: - "#^Unsafe usage of new static#" 実行 ddev exec phpstan 82 -
PHPStan エラー例 Note: Using configuration file /var/www/html/phpstan.neon. 3/3 [▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓] 100%
------ -------------------------------------------------------------------------------------------------------------------------------------- Line site_notice/tests/src/Unit/SiteNoticeBlockTest.php ------ -------------------------------------------------------------------------------------------------------------------------------------- 80 Call to method PHPUnit\Framework\Assert::assertIsArray() with array will always evaluate to true. method.alreadyNarrowedType Because the type is coming from a PHPDoc, you can turn off this check by setting treatPhpDocTypesAsCertain: false in your phpstan .neon. ------ -------------------------------------------------------------------------------------------------------------------------------------- [ERROR] Found 1 error Failed to execute command `phpstan`: exit status 1 83 -
PHPStan 導入ポイント レベルは0から始めて最大5までがおすすめ レベル6とDrupalのRender Array定義が相性が悪い Rule Levels 補足 :Drupal11.3でレンダリング要素をオブジェクトで作成できる機 能が登場
します。オブジェクトでの実装が浸透して、メソッドの引 数もオブジェクトになったらこの問題は解消します。 [1] https://www.drupal.org/node/3532720 84 -
PHPUnit セットアップ core/phpunit.xml.distをプロジェクトルートにコピー 設定値変更 bootstrapのパス ・・・ docroot/core/bootstrap.php や web/core/bootstrap.php など
SIMPLETEST_BASE_URL ・・・ http://localhost SIMPLETEST_DB の変更 ・・・ DDEV例: mysql://db:db@db/test テスト対象の設定 <testsuites></testsuites> のカスタマイズ [1] https://github.com/kazukomurata/drupal-example-2025/blob/main/phpunit.xml 86 -
PHPUnit エラー例 PHPUnit 11.5.34 by Sebastian Bergmann and contributors. Runtime:
PHP 8.4.10 Configuration: /var/www/html/phpunit.xml F.. 3 / 3 (100%) Time: 00:00.017, Memory: 6.00 MB There was 1 failure: 1) Drupal\Tests\site_notice\Unit\SiteNoticeBlockTest::testBuildBeforeStartReturnsEmptyWithCacheUntilStart Failed asserting that Array &0 [] is null. /var/www/html/docroot/modules/custom/site_notice/tests/src/Unit/SiteNoticeBlockTest.php:80 FAILURES! Tests: 3, Assertions: 11, Failures: 1. Failed to execute command `phpunit docroot/modules/custom/`: exit status 1 88 -
PHPUnit in Drupal 種類 種類 おすすめ Unit Drupalに依存しない機能のテスト Kernel Drupalのサービスに依存する機能のテスト
Functional ブラウザ風テスト FunctionalJavascript JavaScriptの動作確認テスト 89 -
PHPUnit Tips 最初に追加するなら実行までの難易度低めのKernelテスト サービスやメソッド呼び出しでエラーにならないことのテストを用意するの がおすすめ DrupalのアップグレードでAPIの変更、非推奨APIを検知できる サイト構成、Content Entityの用意はCreationTraitを使うのがお すすめ Nodeなら
ContentTypeCreationTrait、NodeCreationTrait 90 -
GitHub Actions の CodeQL Settings > Advanced Security で Code
scanning を設定、 CodeQL による静的解析が可能 [1] https://docs.github.com/ja/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning- with-codeql 98 -
GitHub Actions デプロイ AWS EC2のようなサーバにデプロイ サーバにGitHubセルフホステッドランナー設定 (SSHで接続ではない) 実行先をサーバーにする AWS ECSのようなコンテナサービス
Dockerイメージをビルド、リポジトリに登録 コンテナ更新指示を実行する 99 -
GitHub Actions セルフホステッドランナー の場合 GitHub の Settings > Actions >
Runners で 新規追加で表示さ れる指示に従ってランナー追加 & サービス常時起動 [1] https://docs.github.com/ja/actions/how-tos/manage-runners/self-hosted-runners/add-runners 100 -
.github/workflows/deploy.yml 作成 name: Deploy on: push: branches: - main permissions:
contents: read jobs: deploy: runs-on: self-hosted defaults: run: shell: bash working-directory: ${{ vars.APP_ROOT }} steps: - name: "Update" run: | git pull origin main composer install --no-dev vendor/bin/drush cr vendor/bin/drush cim -y vendor/bin/drush cr vendor/bin/drush updb -y 101