GitHub Actions チートシート - 標準的な構造と最も役立つアクションのリスト

GitHub Actions
は、プッシュ、プルリクエスト、またはスケジュールなどのイベントに基づいてコードを構築、テスト、デプロイするためのGitHub内での自動化およびCI/CDプラットフォームです。

標準的なGitHubだけでなく、自己ホスト型のGiteaサーバーでもGitHub Actionsを使用できます。

この概要では、GitHub Actionsの構造、簡単な説明、オープンソースおよび商用ワークフローでよく使われるアクションについて説明しています。
アクションは、公式、コミュニティ、およびサードパーティのツールを含み、ビルドやテストからデプロイ、リリース管理、QA、通知までをサポートします。

基本的な構成構造

GitHub Actionsのワークフローは、リポジトリ内の.github/workflowsディレクトリに配置されたYAMLファイルで定義されます。

name: Workflow Name
on:
  push:
    branches: [ main ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
      - name: Run tests
        run: npm test

• onブロックはトリガーイベントを指定します。
• 各jobは独自のランナーで実行されます。
• stepsはシェルコマンドを実行したり、再利用可能なアクションを呼び出したりできます。

核心的なワークフロー構成要素

トリガーイベント

• push
• pull_request
• schedule（cron構文を使用）
• workflow_dispatch（手動トリガー、入力パラメータを許可）
• release, issueなど

例:

on:
  push:
    branches: [ main ]
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string

有用な組み込みアクション

アクションのパラメータ

任意のアクション呼び出しの一般的なパラメータ:

- name: Some Action or Step
  uses: owner/repo@ref
  with:
    param1: value
    param2: value
  env:
    ENV_VAR: value
  if: ${{ condition }}
  run: command_to_run
  shell: bash|pwsh|python|sh
  continue-on-error: true|false

• with: アクションに渡される引数（アクションのドキュメントを参照）
• env: ステップの環境変数
• if: 条件付き実行
• run: アクションを使用しない場合のシェルコマンド
• shell: ステップを実行するシェル
• continue-on-error: ステップが失敗しても継続

カスタムアクション入力の定義

アクションメタデータ（action.yml）内で:

inputs:
  example-input:
    description: 'An example input'
    required: false
    default: 'default-value'

ワークフロー内で使用する場合:

- uses: my/action@v1
  with:
    example-input: 'custom-value'

アクションが実行される際には、環境変数INPUT_EXAMPLE_INPUTとしてアクセス可能です。

例: 手動パラメータ付きワークフロー

name: Deploy
on:
  workflow_dispatch:
    inputs:
      environment:
        description: 'Deployment Environment'
        required: true
        default: 'production'
        type: string
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
      - name: Deploy to environment
        run: echo "Deploying to ${{ github.event.inputs.environment }}"

アクションマーケットプレイス

• GitHub Marketplaceには、数千の再利用可能なアクションが利用可能です。
• カテゴリには、クラウドデプロイ、通知ツール、テストフレームワーク、コード分析、などがあります。
• 探索: actions/checkout, actions/setup-node, docker/build-push-action, actions/cache, actions/upload-artifact、他多数。

クイックヒント

• ワークフローファイルは.github/workflowsに配置してください。
• workflow_dispatchとinputsを使用して、手動およびパラメータ付きの実行を行ってください。
• cacheアクションを使用して、依存関係のインストールを高速化してください。
• job matrixを使用して、複数のOS/ランタイムバージョンでテストしてください。
• 敏感なデータは、${{ secrets.SECRET_NAME }}として参照するセキュリティで保護してください。

このチートシートは、GitHub Actionsを使用して自動化、CI/CD、およびその他のタスクを構成、設定、拡張するための基本的な情報をカバーしています。詳細や更新については、常に公式のGitHubドキュメントおよびアクションリポジトリを確認してください。

一般的なGitHub Actions

ここでは、CI/CD、テスト、ビルド、デプロイ、ワークフロータスクの自動化に役立つ頻繁に使用されるGitHub Actionsの実用的なリストを示します。

公式コアアクション

人気のあるコミュニティおよびサードパーティアクション

テスト、QA、レポートアクション

デプロイおよび通知アクション

ユーティリティおよびワークフロー管理

より多くのアクションを探す方法

自動テスト、プロダクションへのデプロイ、通知、他のサービスとの統合など、ワークフロー自動化を可能にする多くのGitHub Actionsがあります。 GitHub Marketplaceには、テスト、セキュリティ、デプロイ、通知、コード品質、統合など、カテゴリごとに数千のアクションが掲載されています。 「Awesome Actions」などのキュレーション済みリストも、インスピレーションや発見に役立ちます。

有用なリンク

• https://docs.github.com/actions
• https://github.com/marketplace
• https://docs.github.com/en/actions/get-started/quickstart
• https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
• GITチートシート
• Gitea - インストールとテスト
• Giteaサーバーのバックアップと復元
• Gitea Actionsを使用してHugoサイトをAWS S3にデプロイ
• Gitflow: ステップ、代替案、利点、欠点
• GitOpsによるDevOps - Argo CD、Flux、Jenkins X、Weave GitOpsなど