Webhook を手動でテストする

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：6分

    • GitLab、Rally、Split.io、Jira、Bitbucket、Argo CD などのツールでは、接続に問題がある場合は Webhook を手動でテストする必要があります。

    GitLab

    必要なロール：
    • GitLab: GitLab 管理者権限
    • DevOps 変更:sn_devops.admin または sn_devops.tool_owner
    GitLab で Webhook を手動でテストするには、次のことを行う必要があります。
    1. [ GitLab ] に移動し、Webhook をテストするプロジェクトを選択します。
    2. 移動先 設定 > Webhook.

      プロジェクトが DevOps チェンジベロシティ で構成されている場合、そのプロジェクトの Webhook が GitLab で作成されます。これらの Webhook は [プロジェクトフック] で使用できます。

      GitLab の Webhook。

      プロジェクトごとに、2 つの Webhook が作成されます。1 つはコード イベント用で、もう 1 つはオーケストレーション イベント用です。

    3. Webhook をテストするには、 [ テスト ] を選択し、一覧から [プッシュ イベント ] を選択します。

      Webhook をテストします。

      注:
      タグプッシュイベントなど、他のイベントもテストできます。
      • Webhook が正しく構成されている場合は、成功メッセージが表示されます。例：

        成功メッセージ。

      • Webhook が正しく構成されていない場合は、エラーメッセージが表示されます。例：

        エラーメッセージ。

        Webhook を修正するには、次のオプションを試すことができます。
        • DevOps チェンジベロシティ のプロジェクトレコードページから [構成] を選択して、Webhook を再構成します。これにより、プロジェクトの既存のすべての Webhook が再構成されます。

        • Webhook の [編集] を選択し、[URL] フィールドでtoolIdが正しいかどうかを確認します。シークレットトークンが正しいかどうかを確認します。

          正しい値は、 DevOps チェンジベロシティ のツールレコードページで確認できます。

          Webhook フィールドを確認します。

    GitLab の Webhook の詳細については、「Webhook」を参照してください。

    Rally

    必要なロール：
    • Rally: Rally 管理者権限
    • DevOps 変更:sn_devops.admin または sn_devops.tool_owner
    Rally には、Webhook 接続を直接テストするオプションはありません。DevOps チェンジベロシティにRallyイベントが表示されない場合は、次のオプションを試すことができます。

    • Rallyインスタンスから、 自分の設定 > システム管理 > 拡張 > Webhook.

      DevOps 変更 インスタンスに対応する Webhook が作成されているかどうか、およびそれがアクティブであるかどうかを確認します。

      Rally の Webhook。

    • DevOps チェンジベロシティ のプロジェクトレコードページから [構成] を選択して、Webhook を再構成します。これにより、プロジェクトの既存の Webhook が再構成されます。

    Rally の Webhook の詳細については、「Webhook の管理」を参照してください。

    Split.io

    必要なロール：
    • Split.io:Split.io アドミン権限
    • DevOps 変更:sn_devops.admin または sn_devops.tool_owner
    Split.io には、Webhook 接続を直接テストするオプションはありません。DevOps チェンジベロシティ に Split.io イベントが表示されない場合は、次の方法をお試しください。

    • Split.io インスタンスから、 管理者設定 > 統合設定 > 統合. [ 構成済み ] タブを選択し、ServiceNow DevOps アプリケーションの [編集 ] を選択します。

      ServiceNow DevOps アプリケーションを構成します。

      ServiceNow DevOps アプリケーションが Split.io で正しく構成されているかどうかを確認します。構成の詳細については、「 分割ツールで ServiceNow DevOps との統合を有効にする」を参照してください。

    • ServiceNow DevOps アプリケーションのステータスが アクティブかどうかを確認します。

      ServiceNow DevOps アプリケーション。

    • DevOps チェンジベロシティ のツールレコードページから [構成] を選択して、Webhook を再構成します。これにより、Split.io ツールの既存の Webhook が再構成されます。

    「 ServiceNow と Split.io の統合」も参照できます。

    Jira

    必要なロール：
    • Jira: Jira 管理者権限
    • DevOps 変更:sn_devops.admin または sn_devops.tool_owner
    Jira には、Webhook 接続を直接テストするオプションはありません。DevOps チェンジベロシティにJiraイベントが表示されない場合は、次のオプションを試すことができます。
    • 移動先：
      • Jira Serverの場合は、 管理 > システム > Webhook.
      • Jira クラウドインスタンスの場合は、 設定 > システム > Webhook.

      DevOps 変更インスタンスに対応する Webhook が作成されているかどうかを確認します。

      DevOps 変更の Webhook。

    • Webhook の [編集 ] を選択します。
      • ステータスが [有効] になっているかどうかを確認します。
      • [URL] フィールドのTool IDが正しいかどうかを確認します。Tool IDは?toolId=の後の値です。
      • [URL] フィールドのシークレットトークンが正しいかどうかを確認します。トークン値は、URL の末尾の token=の後にあります。

      Webhook フィールド。

      Tool IDとSecret tokenの正しい値は、DevOps チェンジベロシティ のツールレコードページで確認できます。

      Jira の Webhook の詳細については、「Webhook」を参照してください。

    • DevOps チェンジベロシティ のツールレコードページから [構成] を選択して、Webhook を再構成します。これにより、 Jira ツールの既存の Webhook が再構成されます。

    Bitbucket

    必要なロール：
    • Bitbucket: Bitbucket 管理者権限
    • DevOps 変更:sn_devops.admin または sn_devops.tool_owner
    Bitbucket には、Webhook 接続を直接テストするオプションはありません。DevOps チェンジベロシティにBitbucketイベントが表示されない場合は、次のオプションを試すことができます。

    • Bitbucket に移動し、Webhook をテストするリポジトリを選択します。移動先 リポジトリ設定 > ワークフロー > Webhook.

      DevOps 変更インスタンスに対応する Webhook が作成されているかどうかを確認します。

      リポジトリ Webhook。

    • Webhook の [編集 ] を選択します。
      • ステータスが [アクティブ] かどうかを確認します。
      • [URL] フィールドのTool IDが正しいかどうかを確認します。Tool IDは/event/の後の値です。
      • [URL] フィールドのシークレットトークンが正しいかどうかを確認します。トークン値は、URL の末尾の token=の後にあります。

      Tool IDとSecret tokenの正しい値は、DevOps チェンジベロシティ のツールレコードページで確認できます。

      リポジトリ設定。

      Bitbucket の Webhook の詳細については、「Webhook の管理」を参照してください。

    • DevOps チェンジベロシティ のツールレコードページから [構成] を選択して、Webhook を再構成します。これにより、 Bitbucket ツールの既存の Webhook が再構成されます。

    アルゴCD

    必要なロール：
    • Argo CD: Argo CD の管理者権限
    • DevOps 変更:sn_devops.admin または sn_devops.tool_owner

    Argo CD には、Webhook 接続を直接テストするオプションはありません。Webhook を構成するには、「 Argo CD での Webhook の手動構成」を参照してください。