Ctrlk
Changelog NotificationsAPIAikido login
For the complete documentation index, see llms.txt. This page is also available as Markdown.

AutoShip概要

AutoShipはセキュリティ修正を提供するので、機能開発に集中できます。

AutoFix は壊れないプルリクエストを作成するよう最適化されていますが、意図しない実行時の影響がないことを確認するために、本番相当の環境で変更をテストする必要があります。そのため、AutoFix によって作成されたプルリクエストをリリースするにはかなりの時間がかかることがあります。必要な作業は次のとおりです:

  1. CI/CD の結果を確認する

  2. テスト環境にデプロイする

  3. テスト環境で新しいエラー／リグレッションがないことを確認する

  4. 何も壊れていないことを確認するテストを実施する

これらのテストが完了したら、プルリクエストは安全に本番へリリースできます。

AutoShip は、このプロセスを自動化するために、すべての実行時システムと統合します。AutoShip はプルリクエスト上のラベルを元に開始します。ラベルが追加されると、AutoShip はプルリクエストをリリースする処理を開始します。

はじめに

次へ移動します： AutoShip Aikido の UI で、まずグローバル設定を行います。書き込み権限、トリガーに使うラベル、デプロイ先の環境を指定してください。CI/CD、監視、アラートの統合を接続したら、リポジトリごとに AutoShip を有効化し始めることができます。各リポジトリごとに、使用する CI/CD と、AutoShip がデプロイすべき環境を設定する必要があります。各環境ごとに、リグレッションを検出するための監視情報の場所と、その環境に対してどのようにスモークテストを行うかを指定できます。

グローバル設定

On the AutoShip > 設定ページ AutoShip を設定できます:

AutoShip の書き込み権限

現在サポートしているのは GitHubのみです。書き込み権限は Aikido AutoShip GitHub アプリを通じて提供されます。このアプリは Aikdio AutoFix GitHub アプリとは別です。AutoFix を有効にするリポジトリと、AutoShip を有効にするリポジトリを個別に設定できます。

トリガーラベル

AutoShip は、指定されたラベルが付いたプルリクエストでトリガーされます。このラベルは設定可能で、AutoShip が有効なすべてのリポジトリでトリガーとして使用されます。

環境

AutoShip がデプロイ可能なさまざまな環境を指定します。通常、最初の環境はステージング環境で、変更を安全にテストする場所です。最初の環境で変更がテストされ検証されると、次の環境へ進みます。通常、2つ目の環境は本番環境で、AutoShip はデプロイを監視し、スモークテストを実行して変更を検証します。

環境は複数のリポジトリ間で再利用できます。グローバル設定で環境名とブランチを指定すると、各リポジトリで簡単に再利用できます。

ブランチ名は AutoShip による安全装置として使用されます。AutoShip はこのブランチにのみマージできます。たとえば、 staging ブランチへマージしてステージング環境にデプロイする場合、そのブランチ名を指定する必要があります。そうしないと AutoShip はマージできません。これにより、AutoShip がリポジトリ内の重要なブランチ（例: main や production）へマージするのを防ぎます。

CI/CD

AutoShip は CI/CD システムに接続して、ビルドが通っているかを確認します。ビルドに問題が発生すると、AutoShip がそれを修正し、修正をプルリクエストのブランチにプッシュします。

グローバル設定で CI/CD システムを接続します。多くの場合、API キーが必要です。システムごとの詳細は CI/CD ページを参照してください。現在は GitHub Actions と CircleCI をサポートしています。

リポジトリの設定時には、リポジトリごとの追加設定（例: プロジェクト）を指定できます。

監視

環境へのデプロイが成功すると、AutoShip は監視システムのデータを確認して、新しいエラーがないことを検証します。リグレッションが検出された場合、AutoShip は変更をロールバックします。

グローバル設定で監視システムを接続します。多くの場合、API キーが必要です。システムごとの詳細は 監視 ページを参照してください。現在は Sentry と CloudWatch をサポートしています。

リポジトリの設定時には、リポジトリごとの追加設定（例: プロジェクト）を指定できます。

アラート

AutoShip は進行状況を随時お知らせします。これは Slack を通じて行えます。AutoShip はデプロイごとにスレッドを作成し、進捗メッセージを投稿します:

リポジトリごとの設定

グローバル設定が完了し、統合が接続されたら、あとはリポジトリで有効化するだけです。

CI/CD

このリポジトリで使用される CI/CD システムを選択します。GitHub Action と CircleCI は選択するだけでよく、追加の設定は不要です。

環境

このリポジトリで有効にしたい環境を選択します。最終的な手動確認のために、本番までリリースせずに一部のリポジトリをテスト環境へデプロイすることもできます。

環境設定では、次の項目を指定します:

  • AutoShip がこの環境へどのようにデプロイするか。 これらは自由記述の指示です。例: PR ブランチを staging ブランチにマージする.

  • AutoShip が機能をどのようにテストするか。 ここでは、どのドメインをテストするか、そのドメインへの認証方法、テスト方法に関する自由記述の指示を指定します。例: 商品をカートに追加し、チェックアウトページに表示されていることを確認する. スモークテストに関する詳細情報。

  • AutoShip がリグレッションをどのように検出するか。 このリポジトリと環境で使用される監視システムを AutoShip に指定します。例: staging のサービスに対する CloudWatch ログの場所。

アラート

AutoShip の進行状況について通知を受け取りたい Slack チャンネルを指定します。

試してみましょう！

指定したラベル（例: autoship）をプルリクエストに追加します。

  • Aikido AutoShip アプリが GitHub のチェックに表示されます

  • Slack メッセージが投稿されます

最終更新

役に立ちましたか？