AutoFix PR設定

プルリクエスト設定

AutoFixのプルリクエストは、次を使ってニーズに合わせて設定できます「PR設定」。次のフィールドを変更できます:

タイトル接頭辞: 社内プロセスに合わせてタイトルをカスタマイズします
ラベル: PRに特定のラベルを追加して、並べ替えと追跡をしやすくします
ブランチ名: Autofixが作成するブランチの接頭辞をカスタマイズします
コミットメッセージ: PR内のコミットメッセージの接頭辞をカスタマイズします
要約: 必要に応じて、各PRに追加メッセージを含めることができます。たとえば、エンジニア向けのカスタム指示や追加の文脈を追加できます。
下書きPRを作成: レビュー準備完了ではなく、下書きPRを作成します。
PRを自動マージ: このためにAikidoは、GitHub、GitLab、Azure DevOpsに組み込まれた自動マージ機能を利用します。詳細はこちら.
PR用のタスクを作成: コンプライアンス上重要です。これにより、接続済みのタスクトラッカーに新しいタスクが自動作成され、作成されたPRへのリンクが設定されます。

Aikidoでは、AutoFix PRのデフォルトレビュアーの設定はサポートしていません。適切な人がレビューするようにするには、リポジトリでCODEOWNERSと必須レビューを使用してください。詳細は AutoFix PRのデフォルトレビュアーの割り当て.

プルリクエストをタスクにリンクする

AutoFixのプルリクエストをタスクにリンクする方法は2つあり、両方を同時に使用できます。

既存タスクのリンク

PRで修正された課題のタスク識別子は、デフォルトでブランチ名に含まれます。workspaceがタスクトラッカーと統合されている場合、PRはタスクトラッカーによって対応するタスクに自動的にリンクされます。

タスク参照プレースホルダー（$TASK_REF ）は次のフィールドで使用できますプルリクエスト設定フィールド:

ブランチ接頭辞
コミットメッセージ
PRタイトル

PRごとに新しいタスクを作成する

各AutoFix PRごとにタスクを作成すると、AutoFix PRのレビューとマージを担当者に割り当てるのに使えます。「PR用のタスクを作成」をAutoFixの設定で有効にしてください。既存タスクにリンクされているかどうかにかかわらず、各AutoFix PRごとにタスクが作成されます。

注: このオプションは現在、Jira と Jira DC でのみ利用できます。

リポジトリ固有の設定

Aikido UIのグローバルAutoFix設定は、Aikidoワークスペース内のすべてのリポジトリに適用されます。特定のリポジトリ向けの設定を行うには、次の .aikido リポジトリのルートにあるファイルを使用します。このファイルで指定した設定はグローバル設定を上書きします。

たとえば、次の設定:

.aikido

autofix:
  single_pr_for_repo: true
  pr_config:
    branch_prefix: "aikido-"
    title_prefix: "Aikido "
    commit_prefix: "[fix] "
    labels: "security"
    draft_pr: false
    auto_merge: true
    create_task_for_pr: true
    task_title_prefix: "[AIK] "
    disable_codeowners_as_reviewers: true
    self_approve_pr: true

リポジトリ内のすべてのlockfileに対して、1つのPRを作成します
ブランチ名は次で始まります aikido-
PRタイトルは次で始まります Aikido
コミットは次で始まります [fix]
PRにはラベルが付きます security
PRは下書きPRではありません
必要な承認がそろうと、PRはSCM（例: GitHub）によって自動マージされます
タスク（例: Jira）がPR用に作成されます
タスク（例: Jira）のタイトルは次で始まります [AIK]
GitLab固有: CODEOWNERSはPRのレビュアーとして追加されません
Bitbucket固有: AutoFixは自身のPRを承認します

以下のセクションでは、各設定パラメータを詳しく説明します。

ブランチ接頭辞

ブランチ接頭辞は、各リポジトリごとに次を追加して設定できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    branch_prefix: "prefix-for-branch-"

AutoFixは次の branch_prefix 値を、そのリポジトリのブランチを作成する際に使用します。この例ではAutoFixは次のようなブランチを作成します: prefix-for-branch-update-dependency-xyz.

ファイルで定義されたブランチ接頭辞は .aikido 、UIで設定されたブランチ接頭辞より優先されます。

ブランチテンプレート

AutoFixはブランチ名にランダムな識別子を追加して一意のブランチ名を作成します。このランダム識別子が、ブランチ命名ルールに合わない場合があります。その場合は、ブランチテンプレートを使ってブランチ名の形式を完全に定義できます。

多くの組織では、タスクとブランチの関連付けを強制するために、これらのブランチ命名ルールを使用します。次の設定により、AutoFixは特定のブランチ名を作成します:

.aikido

autofix:
  pr_config:
    branch_template: fix/$TASK_REF

この $TASK_REF は、プルリクエストで修正された課題にリンクされたタスクに置き換えられます。たとえば: fix/AIK-1234 単一のタスクの場合、または fix/AIK-1234-AIK-4567 複数のタスクの場合。

もし PR用のタスクを作成 を有効にしている場合、自動作成されたタスク識別子がブランチ名に使用されます。

ブランチ形式が非常に厳格で、単一のチケットしか許可しない場合は、次を使用できます: $TASK_REF_0 単一のタスク識別子のみを含めます。

プルリクエストタイトルの接頭辞

プルリクエストタイトルの接頭辞は、各リポジトリごとに次を追加して設定できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    title_prefix: "Title Prefix"

AutoFixはプルリクエストタイトルを次で始めます Title Prefix 。ファイルで定義されたタイトル接頭辞は .aikido 、UIで設定されたブランチ接頭辞より優先されます。

コミット接頭辞

コミット接頭辞は、各リポジトリごとに次を追加して設定できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    commit_prefix: "fix: "

AutoFixは次の commit_prefix 値を、そのリポジトリのコミットを作成する際に使用します。この例ではAutoFixは次のようなコミットを作成します: fix: updating package uuid

ファイルで定義されたコミット接頭辞は .aikido 、UIで設定されたコミット接頭辞より優先されます。

ラベル

ラベルは、各リポジトリごとに次を追加して設定できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    labels: "aikido,security"

AutoFixは次の ラベル 値を、そのリポジトリのプルリクエスト作成時に使用します。この例ではAutoFixは次の両方の aikido と security ラベルをプルリクエストに付けます。

ファイルで定義されたラベルは .aikido 、UIで設定されたラベルより優先されます。 .aikido ファイルで定義されている場合、UIで設定されたラベルは省略されます。

下書きPR

下書きPRは、各リポジトリごとに次を追加して設定できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    draft_pr: true

上記の例では、そのリポジトリのプルリクエストを下書きとして作成します。

ファイル内の下書きPR設定は .aikido 、UIの下書きPR設定より優先されます。

自動マージ

自動マージは、各リポジトリごとに次を追加して設定できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    auto_merge: true

上記の例では、そのリポジトリで自動マージが有効になります。

ファイル内の自動マージ設定は .aikido 、UIの自動マージ設定より優先されます。

PR用のタスクを作成

Aikidoでプルリクエストが開かれると、AutoFixは課題トラッカーにタスクを自動作成します。\nこれは、コンプライアンス基準で求められる是正の追跡可能性を維持するのに役立ちます。

タスク作成は、次を追加することで特定のリポジトリごとに有効/無効を切り替えられます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    create_task_for_pr: true

上記の例では、そのリポジトリでタスク作成が有効になります。ファイル内の設定は .aikido 、UIの設定より優先されます。

タスクタイトルの接頭辞

「PR用のタスクを作成」を有効にすると、次を追加して各リポジトリごとにタスクタイトルの接頭辞を設定できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    task_title_prefix: "[AIK] "

この例では、PR用に作成されるタスクが次で始まるようにします [AIK] 、そのリポジトリで。

ファイル内の設定は .aikido 、UIの設定より優先されます。

レビュアーとしてのCODEOWNERSを無効化する

GitLabでは、Aikido AutoFixは次を追加します CODEOWNERS をマージリクエストのレビュアーとして（lockfileのCODEOWNERSが10人未満の場合）追加します。この挙動は、次を追加することで無効化できます: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
  pr_config:
    disable_codeowners_as_reviewers: true

Bitbucket PRを自己承認する

Bitbucketでは、Aikido AutoFixは作成したPRを承認できます。ワークフローでPRの作成者による承認が必要な場合は、この設定を有効にしてください。

.aikido

autofix:
  pr_config:
    self_approve_pr: true

lockfileごと、またはリポジトリごとのAutoFixのグループ化

デフォルトでは、Aikido AutoFixはリポジトリ内の各lockfileごとに個別のプルリクエストを作成します。 lockfileごと これにより、標準的なプロジェクトでは変更が分離され、レビューしやすくなります。

1つのチームが管理するlockfileが多いリポジトリでは、多数の個別PRを受け取ると煩雑になることがあります。リポジトリごとに1つのプルリクエストにすると、管理負荷とCI/CDの使用量を削減できます。

この動作を変更するには、次を追加します: .aikido リポジトリのルートにあるファイルに、次の内容を記述します:

.aikido

autofix:
    single_pr_for_repo: true

最終更新 1 日前

役に立ちましたか？