GitHub Actions ワークフロー集

GitHub Actions の便利なワークフロー集

GitHub Actions は、CI/CD（継続的インテグレーション/継続的デリバリー）を自動化するための強力なツールです。ここでは、日常的に利用する便利なワークフローをいくつか紹介します。これらのワークフローを組み合わせることで、より効率的な開発プロセスを実現できます。

1. コードの変更を監視し、テストを実行するワークフロー

これは最も基本的なワークフローです。GitHub リポジトリの変更を監視し、変更が検出された場合に、テストを実行します。例えば、Python のプロジェクトであれば、pytest を実行したり、JavaScript のプロジェクトであれば、Jest を実行したりできます。


steps:
  - name: Checkout code
    uses: actions/checkout@v3

  - name: Run tests
    run: pytest

このワークフローは、開発者がコードを変更した際に、自動的にテストが実行されるため、バグの早期発見に役立ちます。

コードの品質を維持するために、linting や static analysis を行うワークフローも重要です。例えば、Python の場合は、flake8 や pylint を使用したり、JavaScript の場合は、ESLint を使用したりできます。


steps:
  - name: Checkout code
    uses: actions/checkout@v3

  - name: Run ESLint
    run: npx eslint .

このワークフローは、コードのスタイルガイドラインに準拠しているか、潜在的なエラーがないかなどをチェックします。

ドキュメントを自動生成することで、開発者の作業を効率化できます。例えば、Python の場合は、Sphinx を使用したり、JavaScript の場合は、JSDoc を使用したりできます。


steps:
  - name: Checkout code
    uses: actions/checkout@v3

  - name: Generate documentation
    run: sphinx-build . _build

このワークフローは、コードのドキュメントを最新の状態に保ちます。

プルリクエストが作成された際に、自動的にチェックリストを走らせ、必要な確認事項がすべてクリアされているかを確認するワークフローです。これは、コードレビュープロセスを効率化するのに役立ちます。


steps:
  - name: Checkout code
    uses: actions/checkout@v3

  - name: Run code review checklist
    run: npm run code-review

このワークフローは、プルリクエストがマージされる前に、コード品質、ドキュメント、テストなどがすべてクリアされていることを確認します。

GitHub Actions は、非常に柔軟なワークフローを構築できます。これらのワークフローを参考に、あなたのプロジェクトに最適なワークフローを構築してください。また、GitHub Actions の公式ドキュメントを参考に、さらに多くのワークフローを探索することをお勧めします。