GitHub Issueで書くブログをCakePHP4で実装する

PHPカンファレンス沖縄2022の登壇資料です。

GitHub Issueで書くブログ実装をテーマにCakePHP4のバッチ処理とGitHub Actionsについてお話しました。

Transcript

1. GitHub IssueͰॻ͘ϒϩάΛ CakePHP4Ͱ࣮૷͢Δ at PHPΧϯϑΝϨϯεԭೄ2022
5. ࠓ೔͓࿩͢͠Δ͜ͱ • ίϯςϯπ੩తԽʹֶͿCakePHP4ͷόονॲཧ • GitHub ActionsΛ࢖ͬͨهࣄެ։ͷࣗಈԽྫ 
   1)1ΧϯϑΝϨϯεԭೄ
6. CakePHP4ͷόον࣮૷ 
   1)1ΧϯϑΝϨϯεԭೄ
7. CakePHP4ͷόον࣮૷ • CakePHP͸ίϯιʔϧϑϨʔϜϫʔΫͱͯ͠ͷػ ೳ΋͍࣋ͬͯ·͢ • /src/Command/ҎԼʹϑΝΠϧΛઃஔ • bin/cake {ίϚϯυ໊} Ͱ࣮ߦ • ඪ४ఏڙ͞Ε͍ͯΔίϚϯυ΋͍͔ͭ͋͘Γ·͢ ʢbakeͱ͔migrationsͱ͔ʣ 
   1)1ΧϯϑΝϨϯεԭೄ
8. <?php namespace App\Command; use Cake\Command\Command; use Cake\Console\Arguments; use Cake\Console\ConsoleIo; class HelloCommand extends Command { public function execute(Arguments $args, ConsoleIo $io) { $io->out('Hello world.'); } } /src/command/HelloCommand.php
9. [vagrant@localhost html]$ bin/cake hello Hello world. /src/command/HelloCommand.php
10. IssueΛ΋ͱʹHTMLԽ͢Δ 
    1)1ΧϯϑΝϨϯεԭೄ
11. ࢓༷ͷΠϝʔδ 1. GitHub Issueͷ৘ใΛऔಘ͠ɺͦΕΛ΋ͱʹ هࣄσʔλΛ࡞੒ 2. දࣔ༻ͷϏϡʔςϯϓϨʔτΛ४උ 3. HTMLԽͯ͠อଘ 
    1)1ΧϯϑΝϨϯεԭೄ
12. <?php namespace App\Command; use Cake\Command\Command; use Cake\Console\Arguments; use Cake\Console\ConsoleIo; use Cake\Http\Client; use Michelf\Markdown; use Cake\View\View; class MakeStaticContentsCommand extends Command { public function execute(Arguments $args, ConsoleIo $io) { // GitHub Issueをもとに記事データを作成 $articles = $this->getArticles(); // 記事一覧ページのHTML化 $this->putIndexPageHtml($articles); // 記事詳細個別ページのHTML化 $this->putArticlePageHtml($articles); // 事前に用意しておいたCSSをアップロード用にコピーする $this->copyCSS(); } //... 以後各メソッドを実装してます } /src/command/MakeStaticContentsCommand.php
13. GitHub IssueΛ΋ͱʹ هࣄσʔλΛ࡞੒͢Δ 
    1)1ΧϯϑΝϨϯεԭೄ
15. private function getArticles():array { $issues = $this->getGitHubIssues(); $articles = []; foreach($issues as $issue) { $body = $issue->body; if(preg_match('/### Perm:([a-zA-Z0-9\-]{0,})/', $body, $match)){ $permalink = $match[1]; $body = str_replace($match[0], '', $body); $contents = Markdown::defaultTransform($body); $created = date('Y-m-d H:i:s', strtotime($issue->created_at . ' +9hour')); $articles[] = [ 'permalink' => $permalink, 'title' => $issue->title, 'contents' => $contents, 'created' => $created ]; } } return $articles; } /src/command/MakeStaticContentsCommand.php
16. private function getArticles():array { $issues = $this->getGitHubIssues(); $articles = []; foreach($issues as $issue) { $body = $issue->body; if(preg_match('/### Perm:([a-zA-Z0-9\-]{0,})/', $body, $match)){ $permalink = $match[1]; $body = str_replace($match[0], '', $body); $contents = Markdown::defaultTransform($body); $created = date('Y-m-d H:i:s', strtotime($issue->created_at . ' +9hour')); $articles[] = [ 'permalink' => $permalink, 'title' => $issue->title, 'contents' => $contents, 'created' => $created ]; } } return $articles; } /src/command/MakeStaticContentsCommand.php
17. private function getGitHubIssues() :array { $apiUrl = 'https://api.github.com/repos/{user_name}/{repo_name}/issues'; $http = new Client(); $response = $http->get($apiUrl, null, [ 'headers' => [ 'Accept' => 'application/vnd.github.v3+json', 'Authorization' => 'token ' . {github_access_token} ] ]); return json_decode($response->getStringBody()); } /src/command/MakeStaticContentsCommand.php
18. private function getArticles():array { $issues = $this->getGitHubIssues(); $articles = []; foreach($issues as $issue) { $body = $issue->body; if(preg_match('/### Perm:([a-zA-Z0-9\-]{0,})/', $body, $match)){ $permalink = $match[1]; $body = str_replace($match[0], '', $body); $contents = Markdown::defaultTransform($body); $created = date('Y-m-d H:i:s', strtotime($issue->created_at . ' +9hour')); $articles[] = [ 'permalink' => $permalink, 'title' => $issue->title, 'contents' => $contents, 'created' => $created ]; } } return $articles; } /src/command/MakeStaticContentsCommand.php
19. private function getArticles():array { $issues = $this->getGitHubIssues(); $articles = []; foreach($issues as $issue) { $body = $issue->body; if(preg_match('/### Perm:([a-zA-Z0-9\-]{0,})/', $body, $match)){ $permalink = $match[1]; $body = str_replace($match[0], '', $body); $contents = Markdown::defaultTransform($body); $created = date('Y-m-d H:i:s', strtotime($issue->created_at . ' +9hour')); $articles[] = [ 'permalink' => $permalink, 'title' => $issue->title, 'contents' => $contents, 'created' => $created ]; } } return $articles; } /src/command/MakeStaticContentsCommand.php
20. [vagrant@localhost html]$ bin/cake make_static_contents ### Perm:article-automation このブログはS3でホスティングしています。これまでは記事公開の流れとして・・・ - GitHub Issueで記事を書いて - それをCakePHP4のアプリケーションでHTML化し - S3にアップロードする の流れを手動で行っていたのですが、この度記事を書いてからそれ以降の流れをGitHub Actionsを使って自動化しました。（この記事の公開がテストを兼ねている） GitHub Actionsを触った印象はめちゃくちゃ便利の一言に尽きる感じで、もっと早くにやっておくべきだったなと反省。 最近は記事の更新も月１程度だったんですけど、今回の実装で記事を書くハードルがかなり下がったので今後はまたぼちぼち書いていきたいです。 今回の自動化については、後日詳細な内容をまた書く予定。 $issue->bodyͷத਎
21. [vagrant@localhost html]$ bin/cake make_static_contents <p>このブログはS3でホスティングしています。これまでは記事公開の流れとして・・・</p> <ul> <li>GitHub Issueで記事を書いて</li> <li>それをCakePHP4のアプリケーションでHTML化し</li> <li>S3にアップロードする</li> </ul> <p>の流れを手動で行っていたのですが、この度記事を書いてからそれ以降の流れをGitHub Actionsを使って自動化しました。（この記事の公開がテストを兼ねている）</ p> <p>GitHub Actionsを触った印象はめちゃくちゃ便利の一言に尽きる感じで、もっと早くにやっておくべきだったなと反省。 最近は記事の更新も月１程度だったんですけど、今回の実装で記事を書くハードルがかなり下がったので今後はまたぼちぼち書いていきたいです。</p> <p>今回の自動化については、後日詳細な内容をまた書く予定。</p> HTML੒ܗޙ
22. هࣄσʔλΛϏϡʔʹηοτ͠ɺ HTMLԽͯ͠อଘ͢Δ 
    1)1ΧϯϑΝϨϯεԭೄ
23. CakePHP4ͷϏϡʔपΓ • ڞ௨ͯ͠දࣔ͢Δ಺༰Λ·ͱΊΔϨΠΞ΢τ /templates/layout/default.php • ֤ϖʔδݸผʹදࣔ͢ΔϏϡʔςϯϓϨʔτ ྫ: /templates/Articles/index.php • ViewΛѻ͑ΔΫϥε͕͋Δ • HTMLग़ྗ΋Մೳ 
    1)1ΧϯϑΝϨϯεԭೄ
24. <!DOCTYPE html> <html> <head> <?= $this->Html->charset() ?> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>My Blog</title> <?= $this->Html->css(['main']) ?> </head> <body> <header class="sticky-top"> <nav class="navbar navbar-expand-lg navbar-light bg-light"> <div class="container-fluid"> <?= $this->Html->link('My Blog', '/', ['class' => 'navbar-brand']); ?> </div> </nav> </header> <div class="container"> <?= $this->fetch('content') ?> </div> </body> </html> /templates/layout/default.php(ϨΠΞ΢τ)
25. <main> <?php foreach($articles as $key => $article) { ?> <article class="row"> <header class="col-md-12"> <h1> <a href="/<?= $article['permalink'] ?>/"> <?= $article['title']; ?> </a> </h1> <time><?= $article['created']; ?></time> </header> <section class="col-md-12 mt-3"> <?= nl2br($article['contents']); ?> </section> </article> <?php } ?> </main> /templates/Articles/index.php(Ϗϡʔ)
26. private function putIndexPageHtml(array $articles):void { $view = new View(); $view->setLayout('default'); $view->setTemplatePath('Articles'); $view->setTemplate('index'); $view->set([ 'articles' => $articles ]); $html = $view->render(); file_put_contents(WWW_ROOT . DS . 'uploads' . DS . 'index.html', $html); } /src/command/MakeStaticContentsCommand.php
28. private function putIndexPageHtml(array $articles):void { $view = new View(); $view->setLayout('default'); $view->setTemplatePath('Articles'); $view->setTemplate('index'); $view->set([ 'articles' => $articles ]); $html = $view->render(); file_put_contents(WWW_ROOT . DS . 'uploads' . DS . 'index.html', $html); } /src/command/MakeStaticContentsCommand.php
29. ͦͷଞͷϝιου 
    1)1ΧϯϑΝϨϯεԭೄ
30. private function putArticlePageHtml(array $articles):void { foreach ($articles as $article) { $directory_path = WWW_ROOT . DS . ‘uploads' . DS . $article['permalink']; if(!file_exists(($directory_path))) { mkdir($directory_path, 0775, true); } // HTML取得 $view = new View(); $view->setTemplatePath('Articles'); $view->setTemplate('detail'); $view->set([ 'article' => $article, ]); $html = $view->render(); file_put_contents($directory_path . DS . 'index.html', $html); } } /src/command/MakeStaticContentsCommand.php
31. private function copyCSS():void { $directory_path = WWW_ROOT . DS . 'uploads' . DS . 'css'; if(!file_exists(($directory_path))) { mkdir($directory_path, 0775, true); } copy(WWW_ROOT . DS . 'css' . DS . 'main.css', $directory_path . DS . 'main.css'); } /src/command/MakeStaticContentsCommand.php
32. ࣮ߦ݁Ռ 
    1)1ΧϯϑΝϨϯεԭೄ
33. ࣮ߦ݁Ռ 
    1)1ΧϯϑΝϨϯεԭೄ
34. ࣮ߦ݁Ռ • ࢦఆͷϑΥϧμʹهࣄҰཡɾݸผϖʔδͷ HTML͕࡞ΒΕΔΑ͏ʹͳͬͨ • ϒϥ΢βͰݟͨײ͡΋ҧ࿨ײ͕ͳ͍ • S3ʹΞοϓϩʔυ͢Ε͹ɺϒϩάͱͯ͠ӡ༻ Λ͸͡ΊΒΕͦ͏ 
    1)1ΧϯϑΝϨϯεԭೄ
35. ͱ͸ݴ͑ɺຖճόονΛ࣮ߦͯ͠खಈͰ Ξοϓϩʔυ͢Δͷ΋खؒͰ͢ΑͶ… 
    1)1ΧϯϑΝϨϯεԭೄ
36. GitHub ActionsΛ࢖ͬͯ Ξοϓϩʔυ࡞ۀΛ ࣗಈԽͯ͠ΈΑ͏ 
    1)1ΧϯϑΝϨϯεԭೄ
37. GitHub Actionsͱ͸ 
    1)1ΧϯϑΝϨϯεԭೄ
38. GitHub Actionsͱ͸ • 2019೥ 11݄ެ։ • GitHubͰͷ༷ʑͳૢ࡞ΛτϦΨʔʹɺ͋Β͔ ͡Ίఆٛͨ͠ॲཧ(ϫʔΫϑϩʔ)ͷ࣮ߦ͕Մೳ • .github/workflows/ʹymlͰఆٛ 
    1)1ΧϯϑΝϨϯεԭೄ
39. name: sample on: push jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: ls run: ls -al /.github/workflows/sample.yml
41. name: sample on: push jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: ls run: ls -al /.github/workflows/sample.yml "DUJPOͱ͍͏ׅΓͰ
    ఆٛࡁΈͷૢ࡞͕࣮ߦՄೳ
42. Action(ΞΫγϣϯ) • ActionͰఆٛ͞Εͨૢ࡞͕࣮ߦՄೳ • ϚʔέοτϓϨΠεʹެ։͞Ε͍ͯΔͷͰ ୳ͯ͠ΈΔͱྑ͍ • ؀ڥߏஙपΓͰݴ͏ͱجຊతͳ΋ͷ͸Ұ௨Γ ͋Γͦ͏Ͱ͢ 
    1)1ΧϯϑΝϨϯεԭೄ
44. name: deploy on: push jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: 7.4 extensions: intl mbstring simplexml pdo coverage: none - name: composer install run: composer install - name: Setup MySQL run: | sudo /etc/init.d/mysql start mysql -u root -proot -e 'CREATE DATABASE blog;' - name: app_local.php edit run: | sed -ie "0,/'my_app'/ s/'my_app'/'root'/" ./config/app_local.php sed -ie s/'secret'/'root'/ ./config/app_local.php sed -ie "0,/'my_app'/ s/'my_app'/'blog'/" ./config/app_local.php - name: run CakePHP Shell Command run: bin/cake hello /.github/workflows/sample.yml
46. ϫʔΫϑϩʔ্ͷॲཧͰ S3ʹίϯςϯπΛΞοϓϩʔυ͢Δ 
    1)1ΧϯϑΝϨϯεԭೄ
47. S3΁ͷΞοϓϩʔυ • AWS CLI • $ aws s3 cp {ϑΝΠϧύε} s3://{όέοτ໊} • ಛʹԿ΋ͤͣͱ΋ϫʔΫϑϩʔ্Ͱར༻Մೳ • ͨͩ͠ɺར༻ʹ͋ͨΓೝূपΓͰઃఆ͕ඞཁ 
    1)1ΧϯϑΝϨϯεԭೄ
48. aws-actions/configure-aws-credentials • AWS͕ެ։͍ͯ͠ΔAction • ೝূ৘ใɾϦʔδϣϯ؀ڥͷઃఆΛ୲ͬͯ͘ΕΔ - name: Configure AWS credentials uses: aws-actions/configure-aws-credentials@v1 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: ap-northeast-1 
    1)1ΧϯϑΝϨϯεԭೄ
49. aws-actions/configure-aws-credentials • AWS͕ެ։͍ͯ͠ΔAction • ೝূ৘ใɾϦʔδϣϯ؀ڥͷઃఆΛ୲ͬͯ͘ΕΔ - name: Configure AWS credentials uses: aws-actions/configure-aws-credentials@v1 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: ap-northeast-1 
    1)1ΧϯϑΝϨϯεԭೄ
50. γʔΫϨοτ • ${{ secrets.AWS_ACCESS_KEY_ID }}ͳͲ • ॏཁͳ৘ใΛγʔΫϨοτͱͯ͠ઃఆ͓ͯ͠ ͘͜ͱͰɺද্ࣔϚεΫ͞ΕΔܗͰ ϫʔΫϑϩʔ্Ͱར༻Ͱ͖ΔΑ͏ʹͳΓ·͢ 
    1)1ΧϯϑΝϨϯεԭೄ
52. name: deploy on: issues: types: [opened, edited] jobs: deploy: runs-on: ubuntu-latest steps: - name: Checkout uses: actions/checkout@v2 - name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: 7.4 extensions: intl mbstring simplexml pdo coverage: none - name: composer install run: composer install - name: Setup MySQL run: | sudo /etc/init.d/mysql start mysql -u root -proot -e 'CREATE DATABASE blog;' - name: app_local.php edit run: | sed -ie "0,/'my_app'/ s/'my_app'/'hoge'/" ./config/app_local.php sed -ie s/'secret'/'fuga'/ ./config/app_local.php sed -ie "0,/'my_app'/ s/‘my_app'/'hoge'/" ./config/app_local.php - name: run CakePHP Shell Command run: bin/cake make_static_contents - name: Configure AWS credentials uses: aws-actions/configure-aws-credentials@v1 with: aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} aws-region: ap-northeast-1 env: S3_BUCKET: ${{ secrets.S3_BUCKET }} run: aws s3 cp ./webroot/uploads $S3_BUCKET/ --recursive /.github/workflows/sample.yml
53. ͝੩ௌ͋Γ͕ͱ͏͍͟͝·ͨ͠ʂ