概要前提条件と制限アーキテクチャツールベストプラクティスエピックトラブルシューティング関連リソース

マルチアカウント DevOps 環境に GitHub フロー分岐戦略を実装する

Mike Stephens と Abhilash Vinod、Amazon Web Services

概要

ソースコードリポジトリを管理する場合、さまざまな分岐戦略が、開発チームが使用するソフトウェア開発およびリリースプロセスに影響します。一般的な分岐戦略の例としては、Trunk、GitHub Flow、Gitflow などがあります。これらの戦略では異なるブランチが使用され、各環境で実行されるアクティビティは異なります。DevOps プロセスを実装している組織は、ビジュアルガイドを活用して、これらの分岐戦略の違いを理解できます。組織でこのビジュアルを使用すると、開発チームが作業を調整し、組織の標準に従うのに役立ちます。このパターンでは、このビジュアルを提供し、組織に GitHub Flow 分岐戦略を実装するプロセスについて説明します。

このパターンは、複数のを持つ組織の DevOps ブランチ戦略の選択と実装に関するドキュメントシリーズの一部です AWS アカウント。このシリーズは、クラウドでのエクスペリエンスを効率化するために、最初から正しい戦略とベストプラクティスを適用するのに役立つように設計されています。GitHub Flow は、組織が使用できる分岐戦略の 1 つにすぎません。このドキュメントシリーズでは、Trunk および Gitflow 分岐モデルについても説明します。まだ行っていない場合は、このパターンのガイダンスを実装する前に、マルチアカウント DevOps 環境の Git 分岐戦略の選択を確認することをお勧めします。デューデリジェンスを使用して、組織に適した分岐戦略を選択してください。

このガイドでは、組織が GitHub フロー戦略を実装する方法を示す図を示します。WellAWS -Architected DevOps ガイダンスを確認して、ベストプラクティスを確認することをお勧めします。このパターンには、DevOps プロセスの各ステップで推奨されるタスク、ステップ、制限が含まれます。

前提条件と制限

前提条件

Git、インストール済み。これはソースコードリポジトリツールとして使用されます。
Draw.io、インストール済み。このアプリケーションは、図を表示および編集するために使用されます。

アーキテクチャ

ターゲットアーキテクチャ

次の図は、Punnett 四角形 (Wikipedia) のように使用できます。垂直軸のブランチを水平軸の AWS 環境と並べて、各シナリオで実行するアクションを決定します。数字は、ワークフロー内のアクションのシーケンスを示します。この例では、featureブランチから本番環境へのデプロイまでを案内します。

各ブランチと環境における GitHub Flow アクティビティの Punnett 二乗。

GitHub Flow アプローチの AWS アカウント、環境、ブランチの詳細については、「マルチアカウント DevOps 環境の Git ブランチ戦略の選択」を参照してください。

自動化とスケール

継続的インテグレーションと継続的デリバリー (CI/CD) は、ソフトウェアリリースのライフサイクルを自動化するプロセスです。これにより、本番環境への最初のコミットから新しいコードを取得するために従来必要とされていた手動プロセスの多くまたはすべてを自動化できます。CI/CD パイプラインには、サンドボックス、開発、テスト、ステージング、本番環境が含まれます。各環境では、CI/CD パイプラインはコードをデプロイまたはテストするために必要なインフラストラクチャをプロビジョニングします。CI/CD を使用することで、開発チームはコードを変更し、自動的にテストおよびデプロイできます。CI/CD パイプラインは、機能の受け入れとデプロイに一貫性、標準、ベストプラクティス、最小限の承認レベルを適用することで、開発チームのガバナンスとガードレールも提供します。詳細については、「継続的インテグレーションと継続的デリバリーの実践 AWS」を参照してください。

AWS は、CI/CD パイプラインの構築を支援するように設計された一連の開発者サービスを提供します。例えば、 AWS CodePipelineは完全マネージド型の継続的デリバリーサービスであり、リリースパイプラインを自動化して、迅速かつ信頼性の高いアプリケーションとインフラストラクチャの更新を実現します。はソースコードをAWS CodeBuildコンパイルし、テストを実行し、ready-to-deployソフトウェアパッケージを生成します。詳細については、「Developer Tools on AWS」を参照してください。

ツール

AWS サービスとツール

AWS には、このパターンの実装に使用できる一連の開発者サービスが用意されています。

AWS CodeArtifact は、アプリケーション開発用のソフトウェアパッケージの保存と共有に役立つ、高度にスケーラブルなマネージドアーティファクトリポジトリサービスです。
AWS CodeBuild は、ソースコードのコンパイル、ユニットテストの実行、デプロイ可能なアーティファクトの生成に役立つフルマネージド型のビルドサービスです。
AWS CodeDeploy は、Amazon Elastic Compute Cloud (Amazon EC2) またはオンプレミスインスタンス、 AWS Lambda 関数、または Amazon Elastic Container Service (Amazon ECS) サービスへのデプロイを自動化します。
AWS CodePipeline は、ソフトウェアリリースのさまざまなステージを迅速にモデル化および設定し、ソフトウェアの変更を継続的にリリースするために必要なステップを自動化するのに役立ちます。

その他のツール

Draw.io Desktop は、フローチャートと図を作成するためのアプリケーションです。コードリポジトリには、Draw.io の .drawio 形式のテンプレートが含まれています。
Figma は、コラボレーション用に設計されたオンライン設計ツールです。コードリポジトリには、 Figma の .fig 形式のテンプレートが含まれています。

コードリポジトリ

このパターンの図のこのソースファイルは、GitHub Flow リポジトリの GitHub Git Branching Strategy で入手できます。これには、PNG、draw.io、および Figma 形式のファイルが含まれます。これらの図は、組織のプロセスをサポートするために変更できます。

ベストプラクティス

AWS Well-Architected DevOps Guidance のベストプラクティスと推奨事項に従い、マルチアカウント DevOps 環境の Git 分岐戦略を選択します。これらは、GitHub フローベースの開発を効果的に実装し、コラボレーションを促進し、コード品質を向上させ、開発プロセスを合理化するのに役立ちます。

エピック

タスク説明必要なスキル

タスク	説明	必要なスキル
標準の GitHub フロープロセスを確認します。	サンドボックス環境では、開発者は`feature`ブランチから`main`ブランチを作成し、命名パターンを使用します`feature/<ticket>_<initials>_<short description>`。開発者は`feature`ブランチに 1 つ以上のコミットを追加します。それぞれが個別の変更または改善を表します。開発者はマージリクエスト (MR) を開き、変更を`main`ブランチにマージします。これにより、レビュープロセスが開始されます。レビュープロセス中に、開発者はコードの変更について話し合い、フィードバックを提供します。目標は、変更が高品質で、プロジェクトの基準を満たしていることを確認することです。開発者がマージリクエストを作成すると、自動ビルドプロセスが開始され、`feature`ブランチの変更が開発環境にデプロイされます。自動テストは、マージリクエストにカプセル化された変更の整合性と品質を検証します。マージリクエストを完了するには、ビルドの成功、デプロイの成功、テストの成功が必要です。レビュープロセスが完了すると、変更は`main`ブランチにマージされます。承認者は、テスト環境へのリリースアーティファクトのデプロイを手動で承認します。承認者は、リリースアーティファクトのステージング環境へのデプロイを手動で承認します。承認者は、リリースアーティファクトの本番環境へのデプロイを手動で承認します。	DevOps エンジニア
バグ修正 GitHub フロープロセスを確認します。	開発者は`bugfix`ブランチから`main`ブランチを作成し、命名パターンを使用します`bugfix/<ticket number>_<developer initials>_<descriptor>`。開発者は問題を修正し、修正をコミットして、`bugfix`ブランチを構築します。開発者はマージリクエストを開き、`bugfix`ブランチを`main`ブランチにマージします。これにより、レビュープロセスが開始されます。レビュープロセス中に、開発者はコードの変更について話し合い、フィードバックを提供します。レビューが完了して承認されると、デベロッパーは`bugfix`ブランチのマージリクエストを`main`ブランチに完了します。承認者は、リリースアーティファクトの上位環境へのデプロイを手動で承認します。	DevOps エンジニア
ホットフィックス GitHub フロープロセスを確認します。	GitHub Flow は、コード変更がより高い環境に頻繁に確実にデプロイされる継続的な配信を可能にするように設計されています。重要なのは、すべての`feature`ブランチがいつでもデプロイ可能であることです。 `Hotfix` ブランチは、 `feature` または `bugfix`ブランチに似ていますが、これらの他のブランチと同じプロセスに従うことができます。ただし、緊急性を考慮すると、通常、ホットフィックスの優先度は高くなります。チームのポリシーと状況の即時性によっては、プロセスの特定のステップが迅速化される可能性があります。たとえば、ホットフィックスのコードレビューは高速追跡される場合があります。したがって、ホットフィックスプロセスは機能またはバグフィックスプロセスを並列化しますが、ホットフィックスをめぐる緊急性により、手続きの遵守に変更が必要な場合があります。ホットフィックスが効率的かつ安全に処理されるように、ホットフィックスの管理に関するガイドラインを確立することが重要です。	DevOps エンジニア

標準の GitHub フロープロセスを確認します。

サンドボックス環境では、開発者はfeatureブランチからmainブランチを作成し、命名パターンを使用しますfeature/<ticket>_<initials>_<short description>。
開発者はfeatureブランチに 1 つ以上のコミットを追加します。それぞれが個別の変更または改善を表します。
開発者はマージリクエスト (MR) を開き、変更をmainブランチにマージします。これにより、レビュープロセスが開始されます。
レビュープロセス中に、開発者はコードの変更について話し合い、フィードバックを提供します。目標は、変更が高品質で、プロジェクトの基準を満たしていることを確認することです。
開発者がマージリクエストを作成すると、自動ビルドプロセスが開始され、featureブランチの変更が開発環境にデプロイされます。
自動テストは、マージリクエストにカプセル化された変更の整合性と品質を検証します。マージリクエストを完了するには、ビルドの成功、デプロイの成功、テストの成功が必要です。
レビュープロセスが完了すると、変更はmainブランチにマージされます。
承認者は、テスト環境へのリリースアーティファクトのデプロイを手動で承認します。
承認者は、リリースアーティファクトのステージング環境へのデプロイを手動で承認します。
承認者は、リリースアーティファクトの本番環境へのデプロイを手動で承認します。

DevOps エンジニア

バグ修正 GitHub フロープロセスを確認します。

開発者はbugfixブランチからmainブランチを作成し、命名パターンを使用しますbugfix/<ticket number>_<developer initials>_<descriptor>。
開発者は問題を修正し、修正をコミットして、bugfixブランチを構築します。
開発者はマージリクエストを開き、bugfixブランチをmainブランチにマージします。これにより、レビュープロセスが開始されます。
レビュープロセス中に、開発者はコードの変更について話し合い、フィードバックを提供します。
レビューが完了して承認されると、デベロッパーはbugfixブランチのマージリクエストをmainブランチに完了します。
承認者は、リリースアーティファクトの上位環境へのデプロイを手動で承認します。

DevOps エンジニア

ホットフィックス GitHub フロープロセスを確認します。

GitHub Flow は、コード変更がより高い環境に頻繁に確実にデプロイされる継続的な配信を可能にするように設計されています。重要なのは、すべてのfeatureブランチがいつでもデプロイ可能であることです。

Hotfix ブランチは、 feature または bugfixブランチに似ていますが、これらの他のブランチと同じプロセスに従うことができます。ただし、緊急性を考慮すると、通常、ホットフィックスの優先度は高くなります。チームのポリシーと状況の即時性によっては、プロセスの特定のステップが迅速化される可能性があります。たとえば、ホットフィックスのコードレビューは高速追跡される場合があります。したがって、ホットフィックスプロセスは機能またはバグフィックスプロセスを並列化しますが、ホットフィックスをめぐる緊急性により、手続きの遵守に変更が必要な場合があります。ホットフィックスが効率的かつ安全に処理されるように、ホットフィックスの管理に関するガイドラインを確立することが重要です。

DevOps エンジニア

トラブルシューティング

問題ソリューション

問題	ソリューション
ブランチの競合	GitHub Flow モデルで発生する可能性がある一般的な問題は、ホットフィックスを本番環境で発生させる必要があるが、同じリソースが変更されている `feature`、`bugfix`、または `hotfix`ブランチで対応する変更を行う必要があることです。へのマージ時に大きな競合を避けるため、から変更`main`を下位ブランチに頻繁にマージすることをお勧めします`main`。
チーム成熟度	GitHub Flow は、真の継続的インテグレーションと継続的デリバリー (CI/CD) を採用して、より高い環境への毎日のデプロイを促進します。機能を構築し、自動化テストを作成するには、チームにエンジニアリングの成熟度があることが不可欠です。チームは、変更が承認される前に、完全なマージリクエストのレビューを実行する必要があります。これにより、開発プロセスの品質、説明責任、効率性を促進する堅牢なエンジニアリング文化が育まれます。

ブランチの競合

GitHub Flow モデルで発生する可能性がある一般的な問題は、ホットフィックスを本番環境で発生させる必要があるが、同じリソースが変更されている feature、bugfix、または hotfixブランチで対応する変更を行う必要があることです。へのマージ時に大きな競合を避けるため、から変更mainを下位ブランチに頻繁にマージすることをお勧めしますmain。

チーム成熟度

GitHub Flow は、真の継続的インテグレーションと継続的デリバリー (CI/CD) を採用して、より高い環境への毎日のデプロイを促進します。機能を構築し、自動化テストを作成するには、チームにエンジニアリングの成熟度があることが不可欠です。チームは、変更が承認される前に、完全なマージリクエストのレビューを実行する必要があります。これにより、開発プロセスの品質、説明責任、効率性を促進する堅牢なエンジニアリング文化が育まれます。