このリポジトリは、自動ワークフロー用の GitHub Actions セットアップのデモンストレーションです。 GitHub Actions を使用すると、コードのテスト、構築、デプロイなどのさまざまなタスクを GitHub リポジトリ内で直接自動化できます。
このリポジトリには、メイン ブランチへのプッシュ イベントをトリガーする単純なワークフローが含まれています。ワークフローは次の手順で構成されます。
コードのチェックアウト:このステップでは、リポジトリ コードをチェックアウトし、後続のアクションで使用できるようにします。
テストの実行:このステップではテスト スイートを実行し、コードが指定された品質と機能の基準を満たしていることを確認します。
ビルド:該当する場合、このステップではプロジェクトに必要なビルド プロセスを実行します。
デプロイ (オプション):プロジェクトにデプロイが含まれる場合、このステップはアプリケーションを指定された環境にデプロイするように構成できます。
独自のプロジェクトで GitHub Actions を開始するには、次の手順に従います。
.github/workflows
ディレクトリを作成する:リポジトリに、ワークフロー ファイルを保存するための.github/workflows
ディレクトリを作成します。
ワークフロー YAML ファイルの定義: workflows
ディレクトリ内に YAML ファイルを作成し、ワークフロー ステップ、トリガー、および必要な構成を定義します。このリポジトリで提供されているmain.yml
ファイルを参照として使用できます。
ワークフローのカスタマイズ:プロジェクトの特定のニーズに合わせてワークフローを調整します。ステップの追加または削除、トリガーの調整、環境変数の構成を行うことができます。
コミットしてプッシュ:変更をコミットし、メイン ブランチにプッシュします。 GitHub Actions は新しいワークフローを自動的に検出し、定義されたトリガーに基づいて実行を開始します。
ワークフロー ファイル ( main.yml
) の簡略化された例を次に示します。
name : CI/CD Workflow
on :
push :
branches :
- main
jobs :
build :
runs-on : ubuntu-latest
steps :
- name : Checkout Code
uses : actions/checkout@v2
- name : Run Tests
run : |
# Add your test commands here
- name : Build
run : |
# Add your build commands here
- name : Deploy
if : success()
run : |
# Add your deployment commands here (optional)