YouTrack クラウド 2025.1 ヘルプ

GitHub アクション統合

このページの指示に従って、GitHub アクションとの統合を構成します。

YouTrack と github.com(英語) でホストされている VCS リポジトリ間の接続を確立すると、GitHub アクションとの統合が可能になります。YouTrack と GitHub を統合する方法については、GitHub 統合を参照してください。

YouTrack アクションと GitHub アクションの統合により、両方のアプリケーションで便利な機能が有効になります。

  • GitHub アクションで接続されたプロジェクトからパイプライン ID を取得し、解決された課題のビルド番号を保存するカスタムフィールドの値を自動的に更新します。

  • GitHub アクションが課題を参照するコミットを含むジョブを実行するときに、YouTrack の課題にコマンドを適用します。

前提条件

開始する前に、GitHub 統合に使用した認証トークンが有効であることを確認してください。以前にセットアップした GitHub 統合に GitHub アクション統合を追加する場合、トークンの有効期限が間もなく切れる可能性があります。トークンの有効期限を確認し、GitHub の個人アクセストークンページで新しいトークンを生成できます。

GitHub アクション統合ジョブを定義する

GitHub アクションとの統合機能の使用を開始するには、YouTrack で 1 つまたは複数の統合ジョブを定義します。

各統合ジョブは、GitHub アクションの既存のジョブと名前が一致している必要があります。既存の GitHub 統合の設定で統合ジョブを定義できます。

新しい GitHub アクション統合ジョブを定義するには:

  1. YouTrack の 管理メニューから、統合 > VCS 統合を選択します。

  2. 構成された統合のリストからターゲットの GitHub 統合を選択します。

    The option to add a new GitHub Actions integration.
  3. サイドバーで、GitHub アクションセクションまでスクロールします。

  4. 新しい統合ボタンをクリックしてください。

  5. 統合ジョブの名前を追加します。ジョブ名は、GitHub アクション構成ファイル .yml のジョブ名と一致します。GitHub アクションのジョブが YouTrack のどの統合ジョブとも一致しない場合は、YouTrack によって処理されません。

    The setting for storing the name of a GitHub job.
  6. 追加ボタンをクリックしてください。

    • 新しい統合ジョブを追加して有効にしました。

  7. 新しいジョブの設定を定義します。

    Settings for a new job in GitHub.

    これらの設定の詳細については、統合設定を参照してください。

  8. 保存ボタンをクリックしてください。

    • GitHub アクション統合用の新しい統合ジョブを定義しました。

統合設定

統合ジョブでは、次の設定を使用できます。

オプション

説明

完了したジョブからデータを取得する

統合が正常に完了したジョブのみをリッスンするか、ジョブがキャンセルされていない限りすべてのジョブをリッスンするか、すべてのジョブを考慮するかを決定します。

カスタムフィールドの値セットに GitHub アクション ID を追加します

統合された YouTrack プロジェクトでビルド番号が入力されるカスタムフィールドを決定します。選択は、build タイプを格納するカスタムフィールドに制限されています。

GitHub アクションはビルドではなくパイプラインで動作するため、YouTrack はビルド番号ではなくパイプライン ID をカスタムフィールド値として保存します。

選択したフィールドの値は、統合によって更新されたすべての課題で自動的に設定されます。統合の更新する課題を選択してくださいセクションの設定によって、ビルド番号が割り当てられる課題が決まります。

次のオプションを使用できます。

  • 課題を参照しないパイプラインを含める⏤すべてのパイプラインが統合によって処理されるか、YouTrack 課題への参照を含むパイプラインのみが処理されるかを決定します。このオプションで考慮されるパイプラインは、組み立てられたビルドからデータをプルする設定の影響を受けます。

    このオプションを有効にすると、ユーザーは最初に手動でビルド番号を追加しなくても、課題のビルド番号を手動で調整できます。

更新する課題を選択してください

このセクションのオプションにより、統合によってビルド番号が割り当てられる課題が決まります。次のオプションを使用できます。

  • コミットメッセージ、ブランチ名で参照されている課題を更新するか、次の検索条件に一致するコメントを作成します⏤コミットメッセージ、ブランチ名、ビルドコメントに参照が含まれる課題を統合がどのように処理するかを決定します。

    クエリ入力フィールドを使用して、自動ビルド番号割り当てから除外したいメンションのある課題を除外します。コミットメッセージで参照されている課題を更新するオプションが選択解除されている場合、フィルターも同様に無視されます。

  • 次の検索条件に一致する課題を更新します issue 課題の参照が含まれているかどうかにかかわらず、どの課題にビルド番号を割り当てるかを決定します。

    標準の検索基準は次のとおりです。

    State: Fixed State: Verified resolved date: ${prev.build.time} .. ${build.time}

    このクエリは、最後に成功したビルドと現在のビルド以降に解決された課題のみが考慮されることを保証します。

    検索条件に一致する課題を更新するオプションが選択解除されている場合、クエリも無視されます。

両方のオプションが有効になっている場合、ビルド番号はこれら 2 つの条件のいずれかを満たす課題に自動的に割り当てられます。

選択した課題を更新

統合により、自動ビルド番号の割り当てに加えて、選択した課題に変更を適用するかどうかを決定します。コマンドを適用するオプションを有効にすると、ビルド番号が割り当てられているすべての課題に適用される定義済みコマンドを入力できます。

${build} 変数を使用して、GitHub アクションでパイプライン ID を参照します。例:

Subsystem Testing Test in build ${build}

このコマンドを使用すると、YouTrack によって処理されるすべての課題がテストサブシステムに割り当てられ、ビルドテストフィールドがビルド番号に設定されます。

使用可能なアクション

統合ジョブを作成すると、このジョブに対して次のアクションが利用できるようになります。

アクション

説明

編集

統合ジョブの名前を編集できるジョブ名の編集ダイアログを開きます。

除去

YouTrack から統合ジョブを削除します。統合によって行われたすべての変更はそのまま残ります。

プレースホルダー

クエリおよびコマンド設定でプレースホルダーを使用できます。これらのプレースホルダーは、GitHub アクションのジョブおよびパイプライン用に保存されている属性を参照します。ジョブが YouTrack によって処理されると、プレースホルダーは GitHub の対応する値に置き換えられます。次のプレースホルダーを使用できます。

プレースホルダー

説明

${build.time}

YouTrack によって処理されるジョブの日時。

${prev.build.time}

YouTrack によって処理されるジョブより前のジョブの日時。

${build}

YouTrack によって処理されるジョブを含むパイプラインの ID。

トラブルシューティング

GitHub アクション統合の設定で課題が発生した場合は、次のいずれかの条件が当てはまるかどうかを確認してください。

状態 - 統合により、YouTrack の課題にジョブ ID が割り当てられていません。

原因

ソリューション

GitHub に接続する Webhook が関連アクティビティをチェックするように構成されていないか、接続を確立するために使用されるユーザーアカウントに十分な権限がありません。

リストから VCS 統合を選択し、無効にするボタンをクリックします。統合を無効にしたら、有効にするボタンをクリックします。

この操作には 2 つの結果があります。

  • 既存の Webhook に課題があった場合は、自動的に再構成されます。

  • GitHub での認証に使用される個人アクセストークンが検証されます。トークンの権限が不十分な場合は、必要な権限スコープが付与された別のトークンを生成します。

関連ページ:

GitHub 統合

このページの指示に従って、github.com または自己ホスト GitHub Enterprise インストールでホストされている VCS リポジトリと統合してください。GitHub 統合により、YouTrack で以下の機能が有効になります。コミットメッセージの YouTrack 課題にコマンドを適用します。詳細については、VCS コミットでのコマンドの適用を参照してください。YouTrack で、課題のアクティビティストリーム内の特定の課題に関連するコミットを追跡します。詳しくは、コミット数...

ビルドサーバー統合

ビルドサーバーの統合は、開発チームが実行する重複した作業の量を削減できます。YouTrack とビルドサーバーの統合により、両方のアプリケーションで有用な機能が有効になります。YouTrack は、接続されたプロジェクトからビルド番号を取得します。これらのビルド番号を、1 つ以上の統合プロジェクトのカスタムフィールドの値のセットに追加できます。統合設定により、アセンブルされたビルドで参照される課題にビルド番号を自動的に割り当てることができます。ビルド番号が課題に自動的に割り当てられると、YouT...

Jenkins 統合

このページの指示に従って、1 つ以上の YouTrack プロジェクトと Jenkins のプロジェクト間の接続を確立します。YouTrack と Jenkins の統合により、両方のアプリケーションで便利な機能が可能になります。接続されたプロジェクトからビルド番号をプルし、ビルド番号を格納するカスタムフィールドの値を自動的に更新します。コミットメッセージまたはブランチ名で参照される課題に VCS 変更レコードを追加します。YouTrack の課題における VCS の変更の詳細については、VCS...