動機と紹介 ビルド プレビューは、新しいものでも革新的なものでもありません。 Heroku はそれらを何年も前から持っていました。ただし、Google Cloud Platform 上に構築している場合は、少し難しくなります。 Google Cloud Build は、Cloud Functions、Cloud Run、Kubernetes、App Engine などへのデプロイに使用できます。Cloud Build はアプリケーションやサービスのデプロイ先がわからないため、プレビューが少し複雑になります。リポジトリに接続し、GitHub でビルド ステータスを表示する GitHub アプリがありますが、それだけです。 Heroku、Vercel、Fly などの製品で見慣れたプレビュー、コメント、または「通常の」機能はありません。 単純な HTTP リクエストを使用して、Cloud Build から GitHub Pull Request にコメントを投稿する「簡単な」方法があります。しかし、  を使用できるのであれば、なぜ簡単なのでしょうか。 GitHub Deployments API この API を使用すると、環境を作成し、環境ごとに異なる変数を設定し、プル リクエストでビルドとデプロイのステータスを直接表示できます。 CD プラットフォームで展開が完了したら、展開ステータスに URL を追加できます。これがこの記事でやることです。   GitHub デプロイメントステータス 繰り返しますが、これを行う別の方法として、HTTP リクエストで Deployments API を直接使用する方法があります。ただし、これは難しい場合があり、GitHub で認証するためにパーソナル アクセス トークンを定義する必要があります。代わりに、GitHub Apps を使用してアプリ トークンを生成し、Deployments API と対話する小さな Node.js サービスをまとめることにしました。これにより、展開プロセスをもう少し細かく制御できるようになります。 免責事項 この記事は、Google Cloud Platform と GitHub 専用に書かれています。 Google Cloud Platform、Google Cloud Build、IAM 権限についての基本的な理解があることを前提としています。  Google Cloud Platform プロジェクトが設定されている必要があります。  GitHub デプロイヤー (Node.js および Docker)  GitHub Deployer は、GitHub App で認証され、GitHub Deployments API と対話する小さな Node.js サービスです。コマンドは事前定義されており、一部の情報を Docker イメージに組み込む必要があります。そうしないと、Cloud Build のランタイム構成が複雑になりすぎます。  Docker イメージはまだ構築されていません。自分でビルドしてレジストリにプッシュする必要があります。最適な場所は、アプリケーションのイメージも保存される Google Artifact Registry です (Container Registry は非推奨です)。 まだ作成していない場合は、Artifact Registry リポジトリを作成します GitHub アプリを作成して組織にインストールする GitHub アプリを作成する 必要な権限: 「pull_requests」、「deployments」、「metadata」 アプリ ID ([アプリ設定] 画面から) とアプリ インストール ID ([設定] をクリックすると、URL にインストール ID が表示されます。他にどこで見つかるかわかりません) をコピーします。 秘密キーを作成してダウンロードし、base64 に変換します (   )  base64 -i your.private-key.pem  Docker イメージをビルドする ソース Cloud Build は で実行されるため、x86 プラットフォーム用のイメージをビルドするには が必要です。 amd64 buildx   docker buildx build --platform linux/amd64 . -t us-central1-docker.pkg.dev/[PROJECT]/docker/gh-deployer \   --build-arg GH_APP_ID=[GITHUB_APP_ID] \   --build-arg GH_APP_PRIVATE_KEY=[GITHUB_PRIVATE_KEY_BASE_64] \   --build-arg GH_APP_INSTALLATION_ID=[GITHUB_INSTALLATION_ID] \   --build-arg GH_OWNER=[GITHUB_ORG] イメージをレジストリにプッシュします。   docker push us-central1-docker.pkg.dev/[PROJECT]/docker/gh-deployer  Docker イメージをローカルで実行する docker run -it -e REPO_NAME=test -e REF=main -e ENVIRONMENT=test us-central1-docker.pkg.dev/[PROJECT]/docker/gh-deployer:latest create 必要な環境変数:    : リポジトリの名前 (例:   ) REPO_NAME が必要です gh-deployer    : デプロイするにはブランチ、タグ、または SHA (例:   ) REF が必要でした main    : デプロイ先の環境が (例:   ) ENVIRONMENT 必要です preview    :   に設定すると、デプロイメントは一定時間後に削除されます TRANSIENT_ENVIRONMENT オプション/false true  : デプロイメントの説明 DESCRIPTION (オプション) 次のコマンドが最初の引数として使用できます。    - 新しいデプロイメントを作成します create  - ビルドは保留中です pending  - ビルドが進行中です in_progress  - ビルドはキューに入れられています queued  - デプロイメントは成功しました success  - 何か問題が発生しました error  - デプロイメントが失敗しました failure Cloud Build では、現時点ではオプションが少し制限されています。初期デプロイメントを作成するには Cloud Build を開始する必要があるため、  状態はありません。  あまり意味がないので、私たち自身の設定では次のものを使用しています。 pending queued   コミットの一時的なデプロイメントを作成します。 gh-deployer/create   pgh-deployer/ending  kaniko build を実行して、デプロイメント用の Docker イメージをビルドします。 ビルドが完了し、イメージがデプロイされる前の gh-deployer/in_progress   gh-deployer/success 繰り返しになりますが、Cloud Build ではデプロイがどこに行われるかわからないため、デプロイ URL を ステップに渡す方法は 2 つあります。 success ビルドステップで、URL を に書き込みます。 /workspace/deployer_environment_url   したら、2 番目の引数を Docker イメージに渡します success デプロイメントには Cloud Run を使用しているため、特定のプル リクエスト番号のデプロイメント URL を取得するビルド ステップは次のとおりです。  - 名前: gcr.io/google.com/cloudsdktool/cloud-sdk   env: - PR_NUMBER=$_PR_NUMBER script: >- gcloud run services list --project [project] --filter preview-$PR_NUMBER --format "value(status.address.url)" > /workspace/deployer_environment_url  Cloud Build 構成 / Terraform クラウドビルド.yaml クラウドビルド.yaml 以下は、  構成ファイルを使用した完全な例です。構築には Kaniko を使用し、デプロイメント ターゲットとして Cloud Run を使用します。 cloudbuild.yaml  Terraform を使用している場合は、Terraform ファイル も利用できます。 (preview.tf)  GitHub アクション Deployments API を使用すると、  で GitHub アクションをトリガーできます。これにより、各プレビュー ビルドで品質保証チェックやエンドツーエンドのテストなどを簡単に実行できるようになります。  状態として渡される を使用して、各プレビューで 実行する例を次に示します。 deployment_status success environment_url Playwrightを 劇作家QA:   if: ${{ github.event.deployment\_status.state == 'success' }} timeout-minutes: 60 runs-on: ubuntu\-latest steps: \- uses: actions/[\[email protected\]](/cdn-cgi/l/email-protection) \- uses: actions/setup\-[\[email protected\]](/cdn-cgi/l/email-protection) with: node-version: 20 cache: 'npm' \- run: npm ci \- name: Install Playwright Browsers run: npm exec playwright install \-\-with\-deps \-y \- name: Run Playwright tests run: pnpm exec playwright test env: BASE\_URL: ${{github.event.deployment\_status.environment\_url}} \- uses: actions/upload\-[\[email protected\]](/cdn-cgi/l/email-protection) if: always() with: name: playwright\-report path: playwright\-report/ retention-days: 30 最適化 基本イメージ は比較的大きいです。  ビルドを高速化できます。 gcr.io/google.com/cloudsdktool/cloud-sdk Cloud Run コンポーネントを使用して独自の小さな gcloud イメージを構築すると、 結論  GitHub デプロイステータス 完了 GitHub プル リクエストへのコメントは、最初は簡単ですが、プル リクエストごとに複数のデプロイメントがあり、ビルドが失敗するなど、柔軟性があまりなく、維持/更新が困難です。 GitHub Deployments API は、サードパーティの CI/CD システムからデプロイメントを作成および管理するためのエレガントな方法を提供します。  を使用して、デプロイメント API との対話を合理化し、HTTP API だけでは解決できないいくつかの副作用や落とし穴に対処しようとしました。 GitHub Deployer  GitHub Deployments API を使用するもう 1 つの利点は、GitHub Actions の トリガーを使用し、イベント ペイロードで直接 を取得できることです。 deployment_status environment_url もう少し詳しいインストール/ビルド手順とすべてのコードは、  で見つけることができます。 GitHub リポジトリ 、BlueSky/  か、  。 ご質問やコメントがございましたら Twitter にご連絡いただく GitHub のディスカッションに参加してください こちらでも公開しております。

Walkthroughs, tutorials, guides, and tips. This story will teach you how to do something new or how to do something better.

Read My Stories

Problem Solver at Zentered

このオーディオは、ストーリーの元の言語で制作されています。

Google Cloud Platform を使用した GitHub (プレビュー) デプロイメント: 基本ガイド

About Author

コメント

ラベル

この記事は

Related Stories

ユーザー中心の暗号通貨製品の作成: 顧客からのフィードバックの重要性

目に見えない層: ユーザーインタビューがかけがえのない資産である理由

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

AI の力を解き放つ。最先端技術の体系的レビュー: 概要と序論

ユーザー中心の暗号通貨製品の作成: 顧客からのフィードバックの重要性

目に見えない層: ユーザーインタビューがかけがえのない資産である理由

HackerNoon Coded: HackerNoonが最も活発に活動している上位10カ国

AI の力を解き放つ。最先端技術の体系的レビュー: 概要と序論

Light-Mode

Classic

Newspaper

Minty

Dark-Mode

Neon Noir

Minty

HN StartUps