GitHubActions.md

GitHub Actions

Official

• Features • GitHub Actions
• GitHub アクションでワークフローを自動化する - GitHub ヘルプ
  • GitHubホストランナーにインストールされるソフトウェア - GitHub Docs
  • リファレンス - GitHub Docs
• GitHub Marketplace · Actions to improve your workflow
• blog
  • GitHub Actions now supports CI/CD, free for public repositories
  • New workflow editor for GitHub Actions - The GitHub Blog
  • GitHub Actions - new workflow syntax features - The GitHub Blog
  • Working with GitHub Actions | Jeff Rafter
  • GitHub Actions: Manual triggers with workflow_dispatch The GitHub Blog
  • How GitHub Actions renders large-scale logs - The GitHub Blog
• GitHub Actions - GitHub Community Forum
• microsoft/azure-pipelines-image-generation: Azure Pipelines VM image generation for Microsoft-hosted CI/CD
• repository
  • actions/starter-workflows: Accelerating new GitHub Actions workflows
• Work with GitHub Actions in your terminal with GitHub CLI - The GitHub Blog
  • Actions Support · Issue #2889 · cli/cli
• octokit/action.js: GitHub API client for GitHub Actions
• How GitHub Actions handles CI/CD scale on short-running jobs with Ephemeral OS disk Reimage - Microsoft Tech Community

便利 Actions

• GitHub API Request · Actions · GitHub Marketplace
• AWS for GitHub Actions
• Azure/k8s-deploy: GitHub Action for deploying to Kubernetes clusters
• Linter
  • GitHub Actions のワークフローをチェックする actionlint をつくった - はやくプログラムになりたい
  • mpalmer/action-validator: Tool to validate GitHub Action and Workflow YAML files
• Slack
  • Slack Incoming Webhook · Actions · GitHub Marketplace
  • Slatify · Actions · GitHub Marketplace
  • GitHub Actions(beta)向けにslack通知プラグインを作った - 839の日記
  • abeyuya/actions-mention-to-slack: Github Action for convert Github mention to Slack mention.
  • GitHub ActionsをSlack Botから起動する | ten-snapon.com
• Docker
  • docker/build-push-action: Build+push official Docker GitHub action
  • Docker Github Actions - Docker Blog
• WIP
  • WIP · Actions · GitHub Marketplace
• Git
  • stefanzweifel/git-auto-commit-action: Automatically Commit changed Files back to Github with Github Actions
• Pull Request
  • Github Hub · Actions · GitHub Marketplace
  • Create Pull Request · Actions · GitHub Marketplace
• Run Laravel test suite on GitHub Actions with laravel-docker • stefanzweifel.io
• warrenbuckley/Setup-Nuget: Set up your GitHub Actions workflow with the latest version of Nuget.exe CLI tool
• Mackerel
  • リポジトリに含まれるコード量/比率をMackerelに記録する with GitHub Actions & action-mackerel-api - がんばってなんか書く
• ICU
  • GitHub Actions ランタイムを多言語化するアクションを作った ｜ loop.run_forever()
• reviewdog
  • KtLint + Spotless + GitHub ActionsでPRにsuggested changeさせる - Qiita
  • [Go] 新規追加した関数にNew RelicのSegmentを入れ忘れていたら警告するGitHub Actionsを作った - My External Storage
  • reviewdogを使ったGitHub Actionsの作り方 - My External Storage
• cybozu/octoken-action: GitHub Action for creating an installation access token for a GitHub App
• Early Access Program for Qodana, a New Product That Brings the "Smarts" of JetBrains IDEs Into Your CI Pipeline | JetBrains Blog
• yuya-takeyama/auto-cancel-redundant-workflow-runs-action: Auto-cancel redundant Workflow Runs
• gqldoc · Actions · GitHub Marketplace
• Performance
  • Puppeteer +Lighthouse +GitHubActionsで認証付きWebアプリのWebperfを定期計測
• GitHub Actions で失敗したテストをコメントで通知する Action の作成 - Quipper Product Team Blog
• hmarr/auto-approve-action: 👍 GitHub Action for automatically approving GitHub pull requests
• int128/datadog-actions-metrics: Send GitHub Actions metrics to Datadog
• dorny/paths-filter: Conditionally run actions based on files modified by PR, feature branch or pushed commits
• MarceloPrado/has-changed-path: GitHub Action that saves time and money in monorepo environments
• GitHub Actionsでテストのエラーをわかりやすく表示する - たけぞう瀕死ブログ
• GitHub Actions で mkr を使う - Object.create(null)
• Pull Request に含まれる差分ファイルを Tree 形式で可視化する GitHub Action を作った - wadackel.me
• すべての CI の完了をチェックするGitHub Actionを公開しました | by riddle | Jan, 2022 | mixi developers
• lirlia/check-all-ci-completion-action: This repository exposes GitHub Actions that check the completion of all CIs, as indicated by the GitHub check.
• k1LoW/octocov-action: GitHub Action for octocov

参考

• 入門
  • GitHub Actions(v2)ファーストインプレッション 〜v1との違い、導入方法、価格、良い点・悪い点〜 - Hack Your Design!
  • 新 GitHub Actions 入門 - 生産性向上ブログ
  • GitHub Actionsの使い方 | 純規の暇人趣味ブログ
  • GitHubの新機能「GitHub Actions」で試すCI/CD | さくらのナレッジ
  • 入門 GitHub Actions - メドピア開発者ブログ
  • GitHub Actions Deep Dive using PHP / PHPerKaigi 2022 - Speaker Deck
• GitHub Actionsを使ってWebサイト(EC2)の更新を自動化する - Qiita
• 技術情報サイト
  • GitHubActions - Qiita
  • GitHub Actions | Zenn
• git-flow
  • コピペでできるGitHub Actionsでreleaseブランチのマージ、リリースノートの作成の自動化【git-flow用】 - コネヒト開発者ブログ
  • GitHub Actions を使ってリリース時のあれこれを自動化する
• Docker
  • Github Actions にて MySQL container imageを設定+初期化してTestで使う方法と注意 | Qrunch（クランチ）
  • Github Actionsでのdocker buildでキャッシュを有効にする
  • Github Actionsで複数のアーキテクチャ向けのDockerイメージを作る - えんじにあメモ
  • GitHub ActionsでのDockerビルドをキャッシュで高速化する - 🤖
  • GithubActionsでのDocker BuildでCacheを効かせる方法メモ - Qiita
  • GitHub ActionsのイメージビルドをDockerレイヤキャッシュで高速化（翻訳）｜TechRacho（テックラッチョ）〜エンジニアの「？」を「！」に〜｜BPS株式会社
• Terraform
  • GitHub Actionsでsetup-terraformを試す | Developers.IO
  • GitHub Actions を利用しての ECSのBlue/Greenデプロイとトラフィック切り替え前テストを実践 - Qiita
  • Terraform開発時のDeveloper Experienceを爆上げする
  • New Relic One の Terraform CI/CD Pipeline by GitHub Actions - BASEプロダクトチームブログ
  • Ruby on Rails × Terraform × ECS × GitHub Actionsで快適なデプロイ環境（CI/CD）を構築する - Qiita
  • GitHub ActionsでTerraformを実行する - Qiita
  • Terraform で GitHub Actions の secret を管理する | はったりエンジニアの備忘録
  • TerraformコードのセキュリティチェックでCheckovをGitHub Actionsに組み込んでみた - のぴぴのメモ
  • GitHub Actionsでterraform planするworking directoryを動的に抽出する - 弥生開発者ブログ
• AWS
  • 【GitHub Actions】AWS Lambdaの環境変数を自動で更新する - りんごとバナナとエンジニア
  • GitHub Actionsに「強い」AWSの権限を渡したい ~作戦3 - AssumeRole with Google ID Token ~ - KAYAC engineers' blog
    • GitHub Actionsに「強い」AWSの権限を渡したい / AWS credentials on Actions - Speaker Deck
  • 【GitHubActions】単一ワークフローファイルでトリガー元に応じてデプロイ先のAWSアカウントを切り替えてみる | DevelopersIO
  • Github Actionsで使用するAWSのクレデンシャルをGithub Appsで安全にキーローテーションする · ~nabeken/tech/
  • Configure GitHub Actions workflows with a new GitHub Action for building serverless applications
  • GitHub ActionsでCloudflareのキャッシュをパージする - くらげになりたい。
  • AWS_SECRET_ACCESS_KEY を GitHub Actions secrets へ突っ込むのに疲れた俺達は
• インフラ
  • gossとGitHub Actionsでインフラを自動テストした – クラウド・分散システム研究室
• Upptime
• .NET
  • GitHub Actionsで.NET CoreアプリをAzureにデプロイする - Qiita
  • GitHub Actions で .NETプロジェクトの静的コード解析を行う
  • Tyrrrz/GitHubActionsTestLogger: Test logger for .NET that reports results in a format that GitHub Actions understands
• Java
  • Android: Github Actions での最適な Gradle ビルドキャッシュ戦略 - Qiita
  • Android: Github Actions で Gradle build daemon disappeared unexpectedly が発生するときの対処 - Qiita
    • Android: GitHub Actions で Gradle build daemon disappeared unexpectedly が発生しないようにメモリ使用量を調査する - Qiita
• Rust
  • GitHub Actions best practices for Rust projects
• PlantUML
  • GitHub Actions！PlantUMLソースから画像ファイルを自動生成＆コミット！ - Qiita
• Test
  • GitHub ActionsでE2Eのクロスブラウザテストを実装してみる｜SHIFT Group｜note
• GitHub Actions workflowのプロファイラを書いた - 私が歌川です
• Benchmark
  • 継続的にベンチマークを取るための GitHub Action をつくった - はやくプログラムになりたい
  • GitHub Actions で zsh の起動時間を定点観測する
• Submodule
  • GIthub Actions で Git Submodule を 最新に更新して処理する - はいばらのブログ
• Localize
  • GitHub Actions を使って継続的ローカライゼーションをスクラッチから構築した話 | PLAID engineer blog
• Electron
  • Electronで作ったアプリをGitHub ActionsでMac向けにリリースするときの署名と公証について – vi kent
• Issue
  • 【R&D DevOps通信】GitHub Actions: コメント駆動のワークフローを作る - Sansan Builders Blog
• Toast
  • GitHub Actions workflowが完了したらデスクトップ通知を出す - valid,invalid
• 統計
  • GitHub CLIを使ってgithub actionsの実行時間を覗いてみる。(--jsonオプションがworkflowやrunにも欲しい) - podhmo's diary
• GitHub Actionsでデプロイを並列に実行させてCI/CDを高速化してみた | DevelopersIO
• Wiki
  • GitHub ActionsからGitHub wikiを更新する - Islands in the byte stream
• GitHub Actions で複数行の文字列を output にセットする方法 | gotohayato.com
• Chrome Extensions
  • 個人・チーム内でしか使わないようなプライベートなChrome 拡張機能をサクッと作る
• Tailscale
  • Using GitHub Actions and Tailscale to build and deploy applications securely · Tailscale

Monitoring

• Actions: Build Performance Insights · Issue #561 · github/roadmap
• Build monitor for Github Actions, Gitlab CI, Travis CI, Bitrise and Buddy! | Meercode
• CI/CDのデータを収集するCIAnalyzerの紹介
• k1LoW/octocov: octocov is a toolkit for collecting code metrics (code coverage, code to test ratio and test execution time).
• Spendesk/github-actions-exporter: github-actions-exporter for prometheus
• zx + Datadog + GitHub Actions でフロントエンドのコードベースの健全性を可視化する
• GitHub Actions で開発リードタイムとデプロイ数を計測してダッシュボードを作っている話 | mediba Creator × Engineer Blog
• GitHub Actionsでカバレッジを可視化する
• rakutentech/code-coverage-dashboard: Code Coverage Tracking and Dashboard. Documentation below:
• GitHubActionsで効率化した結果を視覚化したい調査編 - Qiita
• Git branchの生存期間を計測するGithub Actionを作った
• Datadog・Lighthouse・GitHub ActionsでWebパフォーマンス定期観測してみた - Retty Tech Blog
• ArtiomTr/jest-coverage-report-action: Track your code coverage in every pull request.
• Mackerelのサービスメトリックを簡単に投稿するためのGitHub Actionsを作った - stefafafan の fa は3つです
• DatadogとGitHub Actionsでサクッとチームのリリース数を可視化してみた - LIVESENSE ENGINEER BLOG

コスト

• Github actions のコスパについて考えた - たゆたふ。

Security

• GitHub Actionsにおけるサプライチェーン攻撃を介したリポジトリ侵害 - RyotaK's Blog

OIDC

• GitHub Actions から OIDC 認証で各クラウドを Terraform デプロイする – Terraform Cloud 編 │ Ether-Zone
  • GitHub Actions から OIDC 認証で各クラウドを Terraform デプロイする – AWS 編 │ Ether-Zone
  • GitHub Actions から OIDC 認証で各クラウドを Terraform デプロイする – GCP 編 │ Ether-Zone
• Optimizing CI/CD Credential Hygiene - A Comparison of CI/CD Solutions - Cider Security Site
• GitHub ActionsでIAMロールを使ってAWSのリソースにアクセスできる仕組みと実装方法について解説｜カルキチのブログ

Action の作り方

• GitHub Actions の JavaScript Action を TypeScript で書いた - はやくプログラムになりたい
• TypeScriptの型エラーをPR上に表示するGitHub Actionsを作成してみた | Studio Andy
• technote-space/release-github-actions: GitHub Actions to automate GitHub Actions releases

Templates

自作する際のテンプレート。

• actions/hello-world-docker-action: A template to demonstrate how to build a JavaScript action.
• actions/javascript-action: Create a JavaScript Action with tests, linting, workflow, publishing, and versioning
• actions/typescript-action

Tips

• node.js で絶対パスや相対パスを取得する方法 npm __dirname
• GitHub Actionsのinputが設定されてない時のcore.getInput()の戻りは「""」（空文字列）になる - nwtgck / Ryo Ota
• [Github Actions]repository_dispatchとworkflow_dispatchの使い分けや書き方の違いをまとめてみた | gkzz.dev

Debug

• デバッグロギングの有効化 - GitHub Docs
• nektos/act: Run your GitHub Actions locally 🚀
  • GitHub Actionsをactを使ってローカルで実行する - @znz blog
  • GitHub Actions を act でローカルテストする - Vがいる日々
  • Githhub Actionsをローカルで実行するnectos/actでcommand not foundが出たときの対処法 - ハイパーマッスルエンジニアになりたい
• GitHub Actions で SSH デバッグ！ (debugging-with-tmate)

Release

• GitHub ActionsでCHANGELOG駆動Release | dondakeshimoの丸太

Platform

Unity

• yukiarrr/unity-build-action: Build Android, iOS, Mac, Windows, and WebGL
• game-ci/unity-actions: Github actions for testing and building Unity projects
  • Github Actions で UnityPackage をビルドしたら快適だった話 - Qiita
  • GameCI で Unity の CI 環境を GitHub Actions で構築する
• GitHub ActionsとUnity-CIで簡単CIビルド構築WebGL対応版 - Qiita
• github actionsでunityビルドしてiOSとAndroidのストアに自動的に提出する - Qiita
• GitHub Actions のセルフホストランナーで Unity ビルドする - フレームシンセシス
• pushしたら自動でUnityビルドが走る人権環境を手に入れる - きゅぶろぐ
• GitHubActionsでUnityのiOSビルドを走らせてXcodeビルドをしてApp Centerに配信するまで - きゅぶろぐ
• GitHubActionsでUnity TestRunnerを走らせる 改 - 底辺の何処か

Android

• GitHub Actions for Android developers | by Enrique López-Mañas | Google Developers Experts | Feb, 2021 | Medium
• Android プロジェクトでの CI/CD 環境を比較 (GitHub Actions vs. GitLab CI/CD) - OPTiM TECH BLOG

iOS

• Apple Github Actions (iOS & macOS)
• GitHub ActionsでiOSアプリをCIする個人的ベストプラクティス / iosdc_2020 - Speaker Deck

WebGL

• GitHub Actions で WebGL2 を動かすまで - Qiita

GitHub ホストランナー

Price

• GithubActionsの料金内訳を集計して可視化してみた - 好奇心の足跡

セルフホストランナー

• 自分のランナーをホストする - GitHub ヘルプ
• [GitHub]ActionsのホストランナーをEC2でやってみた | Developers.IO
• GitHub Actionsでself-hosted runnersを試す - Qiita
• GitHub Actionsで実現する、APIキー不要でGitOps-likeなインフラCI/CD - JX通信社エンジニアブログ
• GitHub Actions の self-hosted runners を AWS ECS で動かして、CI / CD パイプラインを作る - エクサウィザーズ Engineer Blog
• GitHub Actions のセルフホストランナーで Unity ビルドする - フレームシンセシス
• GitHub Actions Self Hosted RunnerをAWS CDKを使ってEC2インスタンスで構築する | Developers.IO
• Tool
  • GitHub-hostedライクなself-hosted Runnerを管理するツールを作った | なぜにぶろぐ
  • Taillook/github-actions-kube-runner: GitHub Actions Kube Runner is Helm Chart of GitHub Actions Self hosted runner for on Kubernetes.
  • summerwind/actions-runner-controller: Kubernetes controller for GitHub Actions self-hosted runnners
  • awesome-runners | A curated list of awesome self-hosted GitHub Action runners in a large comparison matrix
  • GitHub Actions Self-hosted Runner の導入と安定運用に向けた軌跡 - Quipper Product Team Blog
• EC2 Auto-Scaling
  • GitHub Self hosted runners on AWS - part 2 - EC2 - DEV Community
• philips-labs/github-runner/aws | Terraform Registry
• Scaling GitHub Action Runners | 040code
• Terraform で Github Actions の Self Host Runner を作成する - joe tech blog
• actions/virtual-environments を我が手に！セルフビルドしてみた | CyberAgent Developers Blog
• 【GitHub Actions】EC2スポットインスタンスをSelf-hosted runnerとして使うための長い道のり - Qiita

Why self-hosted runners

• GitHub-hosted runners のスペックでは足りない
• 事前にソフトウェアのインストールをしたい
  • ライセンス
  • インストールに時間がかかる、コマンドからできない
• 環境 が勝手に更新されて動かなくなるのを防ぐ
• 無料枠を大幅に超えるので課金するよりセルフホストした方が安い
• リポジトリが大きいので毎回 clone すると遅い
• GitHub Enterprise Server を使っている

Managed self-hosted runner

• BuildJet For GitHub Actions - Make Github Actions Faster

GitHub Actions API

• abskmj/hukum: An NPM module that displays Github Action progress in the terminal and aims to improve your development experience by printing status in realtime.

Deployment

• テストだけでなく、デプロイもGithubで！SlackとGithub Deploymentを使ったGithub Actionsの実行方法 - Qiita
• GitHub Actions上でDeployerを使ってPHPアプリケーションを自動デプロイする - Qiita
• AWS(EC2)への自動デプロイをDeployerからGitHub Actionsに移行する - Qiita
• github ActionsとAWS S3で自動デプロイ環境を作る | ヰ刀のおもちゃ箱
• Deploy Rails apps in 2021 - Speaker Deck

Azure Pipelines

• GitHub Actionsを利用したAzure Pipelines連携を試してみた - kokoni

Dependabot

• [GitHub Actions] Secrets や書き込み権限が必要な Workflow を Dependabot からも使えるようにする – もばらぶエンジニアブログ

足りていないもの

• 手動トリガー
  • デプロイ等に使いたい
• ワークフロー途中での承認
• キャッシュ機構
• セルフホスト
• エラーハンドリング（失敗を許容する）
• 失敗したところから再開

巨大リポジトリを扱う方法

一般的なクラウド CI サービスはまず git clone を行う。しかし巨大リポジトリだとそこで数十分～数時間かかってしまい CI に支障をきたす。
Jenkins の場合ワーキングディレクトリが使いまわされるので予め並列実行数分 git clone しておくなどの対策がとれるがクラウド CI サービスでは難しい。

• リポジトリを分割する
• git clone したディレクトリをキャッシュ
• Git LFS
• VFS for Git
• セルフホストランナー
  • Jenkins のようにできる？

Testing

Web

• cypress
  • 打鍵テストをCIで回す：Cypress on GitHub Actions | フューチャー技術ブログ
  • CypressでFirebase Authenticationのe2eテスト書いてみる
• Selenium

Tips

全般

• ##[error]Repository path 'c:\php-sdk' is not under 'd:\a\Build-PHP-8-on-Windows\Build-PHP-8-on-Windows'
  • https://github.com/SnowCait/Build-PHP-8-on-Windows/runs/869708470?check_suite_focus=true
• Fatal error: Uncaught SDK\Exception: Couldn't execute cl.exe.
  • https://github.com/SnowCait/Build-PHP-8-on-Windows/runs/869976956?check_suite_focus=true
  • Enable Developer Command Prompt · Actions · GitHub Marketplace

PHP

• GitHub Actions で PHP の CI/CD をする - Qiita
• GitHub ActionsでPHPUnitを実行する - Qiita
• GithubActions で phpunit の並列実行 - もがき系プログラマの日常
  • GitHub ActionsでLaravelのPHPUnitを並列実行 - Qiita
• action
  • shivammathur/setup-php: GitHub action to setup PHP with required extensions, php.ini configuration, code-coverage support and various tools like composer...

Problem Matchers

• toolkit/commands.md at master · actions/toolkit
• GitHub Actionsでeslintを動かすだけでFiles changedにlint errorが表示されて便利 - $shibayu36->blog;
• GitHub ActionsのProblem Matchersでtextlintの指摘を表示する - Qiita

Compare

• GitLab
  • モノレポでのCI/CDパイプラインの定義方法を考える(GitLab)