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

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

標準的な GitHub の他にも、セルフホスト型の Gitea サーバー で GitHub Actions を使用することができます。

アクションには公式、コミュニティ、サードパーティ製のツールが含まれており、ビルドやテストからデプロイ、リリース管理、QA、通知までの自動化をサポートしています。

このまとめでは、GitHub Actions の構造、簡単な説明、およびオープンソースおよび商用ワークフローで一般的に使用される最も一般的なアクションについて解説します。 これは、開発者ツール：モダンな開発ワークフローの完全ガイド の一部です。

基本的な構成構造

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 に配置します。
• 手動およびパラメータ化された実行には、inputs と共に workflow_dispatch を使用します。
• 依存関係のインストールを高速化するには cache アクションを使用します。
• 複数の OS/ランタイムバージョンをテストするには、ジョブの matrix を使用します。
• センシティブなデータにはシークレットを使用し、${{ secrets.SECRET_NAME }} として参照します。

このチートシートでは、自動化、CI/CD などにおける GitHub Actions の使用、構成、拡張の基本的な要素をカバーしています。詳細と最新情報については、常に公式の GitHub ドキュメントとアクションリポジトリを確認してください。

一般的な GitHub Actions

以下は、CI/CD、テスト、ビルド、デプロイ、およびワークフロータスクの自動化を支援する頻繁に使用される GitHub Actions の実践的なリストです:

コア公式アクション

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

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

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

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

さらに探す方法

自動化テスト、本番環境へのデプロイ、通知、および他のサービスとの統合など、ワークフロー自動化を可能にする多くの GurHub Actions（GitHub Actions）があります。 GitHub Marketplace には、テスト、セキュリティ、デプロイ、通知、コード品質、統合など、さまざまなカテゴリに数千のアクションがリストされています。 “Awe some 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 など