Skip to content

fix #4119 PhpDocumentor のワークフローが実行されない問題を修正 - #4522

Merged
ryuring merged 1 commit into
5.4.xfrom
fix/php-documentor-runner
Sep 4, 2026
Merged

fix #4119 PhpDocumentor のワークフローが実行されない問題を修正#4522
ryuring merged 1 commit into
5.4.xfrom
fix/php-documentor-runner

Conversation

@ryuring

@ryuring ryuring commented Sep 3, 2026

Copy link
Copy Markdown
Collaborator

概要

PhpDocumentor のワークフローが実行されず、クラスリファレンスが更新されていない問題(#4119)を修正しました。

原因

ジョブが要求するランナー ubuntu-20.04 が GitHub 側で廃止されていたことが原因です。ジョブがキューに滞留したまま、24時間後に自動キャンセルされていました。

実行履歴を確認すると、直近18回の実行すべてが cancelled、かついずれも開始からちょうど24時間後に終了していました。

job labels   : ["ubuntu-20.04"]
created_at   : 2026-08-27T10:36:18Z
completed_at : 2026-08-28T10:36:18Z   ← ちょうど24時間後
conclusion   : cancelled

Issue に書かれていた「おそらく GitHub 側の仕様変更が影響?」という推測どおりでした。

変更内容

1. ランナーを ubuntu-22.04 に変更(本修正)

test.yml で稼働実績のあるランナーに揃えました。

2. actions/checkout を v4 に更新

v3 は Node 20 廃止の対象で、test.yml の CI ログでも警告が出ています。

3. docker イメージのタグ置換を修正

置換元が basercms:php8.1 のままで、docker-compose.yml.default の現在の値 basercms:php8.5 に一致せず、無効な処理になっていました

現状は matrix の php-version8.5 で、default 側の値と偶然一致しているため結果的に動きますが、matrix を 8.4 などに変更しても反映されない状態でした。バージョン部分をパターン指定に変更しています。

# 旧 sed(php8.1 を探す)で matrix=8.4 を指定した場合
image: baserproject/basercms:php8.5   ← 置換されない

# 新 sed の場合
image: baserproject/basercms:php8.4   ← 正しく置換される

4. workflow_dispatch を追加

このワークフローは master への push でのみ動くため、PR の CI では検証できません。手動実行できるようにして、リリースを待たずに動作確認できるようにしました。

検証

ローカルで確認できた範囲は以下のとおりです。

確認項目 結果
YAML の構文・トリガー・ランナー・checkout バージョン パース成功、意図した値を確認
修正した sed の置換動作 上記のとおり、旧版が無効・新版が有効なことを確認
phpdoc の出力先 reference とデプロイ手順の整合 phpdoc.dist.xml<output>reference</output>cp -pr ../reference が一致
コンテナ名 bc-php docker-compose.yml.defaultcontainer_name と一致
XDEBUG_MODE の置換対象 docker-compose.yml.default に存在することを確認

未検証の点

phpDocumentor.phar のダウンロードと実行については、作業環境のネットワークポリシーが phpdoc.org への接続を拒否するため、ローカルで確認できていません。

connect_rejected: gateway answered 403 to CONNECT (policy denial)  host: phpdoc.org:443

ジョブはこれまでランナー待ちの段階で止まっており、ダウンロード以降のステップは一度も実行されていません。そのため、ランナー修正後に別の問題が出る可能性は残ります。

マージ後、追加した workflow_dispatch から手動実行して確認していただくのが確実です。もし後続ステップで失敗した場合は、続けて対応します。

影響範囲

ワークフロー定義のみの変更で、プログラムコードへの影響はありません。

🤖 Generated with Claude Code


Generated by Claude Code

PhpDocumentor のワークフローが 2025年7月以降、直近18回の実行すべてで
cancelled となり、クラスリファレンスが更新されていなかった。

## 原因

ジョブが要求するランナー ubuntu-20.04 が GitHub 側で廃止されており、
ジョブがキューに滞留したまま24時間後に自動キャンセルされていた。

    job labels   : ["ubuntu-20.04"]
    created_at   : 2026-08-27T10:36:18Z
    completed_at : 2026-08-28T10:36:18Z (ちょうど24時間後)
    conclusion   : cancelled

## 対応

- runs-on を、test.yml で稼働実績のある ubuntu-22.04 に変更
- actions/checkout を v4 に更新(v3 は Node 20 廃止の対象)
- docker イメージのタグ置換が実ファイルと一致していなかったため修正
  置換元が basercms:php8.1 のままで、docker-compose.yml.default の
  現在の値 basercms:php8.5 に一致せず、無効な処理となっていた。
  matrix の php-version を 8.5 以外に変更しても反映されない状態だったため、
  バージョン部分をパターンで指定するようにした。
- workflow_dispatch を追加し、master への push を待たずに手動で
  実行確認できるようにした

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings September 3, 2026 07:03

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

docker-compose のイメージタグ置換(sed)が実ファイルの baserproject/basercms:... にマッチせず、matrix 指定が反映されないためです。

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

PhpDocumentor の GitHub Actions ワークフローが GitHub 側の runner 廃止等の影響で実行されず、クラスリファレンス更新が止まっていた問題(#4119)を解消するためのワークフロー修正です。

Changes:

  • runs-onubuntu-20.04 から ubuntu-22.04 に更新し、ジョブがキュー滞留でキャンセルされる問題を回避
  • actions/checkout を v3 → v4 に更新
  • workflow_dispatch を追加して手動実行を可能にし、docker-compose のイメージタグ置換処理を調整
File summaries
File Description
.github/workflows/php_documentor.yml runner/checkout 更新、手動トリガー追加、docker-compose 用のタグ置換処理を更新
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread .github/workflows/php_documentor.yml
@ryuring
ryuring merged commit 02d37a7 into 5.4.x Sep 4, 2026
13 of 14 checks passed
@ryuring
ryuring deleted the fix/php-documentor-runner branch September 4, 2026 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants