Set up code context for your site

コード コンテキストにより、チームがすでに使用しているアトラシアン ツール内で直接、接続されたソース コード リポジトリ全体に対するインテリジェントな検索が可能になります。馴染みのないコードベースを操作する、バグを調査する、Rovo エージェントにタスクのサポートを依頼するなど、どのような場合でも、コード コンテキストによって適切なコードをより迅速に見つけることができます。
コード コンテキストの仕組みについて

はじめる前に

コード コンテキストを有効にする前に、いくつか確認しておくべき事項があります。

1. リポジトリ内のシークレットをスキャンします。コード コンテキストは、オプトインしたリポジトリ内のすべてのコンテンツをインデックス化します。リポジトリにハードコードされた API キー、パスワード、トークン、またはその他の機密データが含まれている場合、そのコンテンツはインデックス化され、リポジトリへのアクセス権を持つすべてのユーザーが検索できるようになります。機能を有効にする前に、シークレットのスキャンを実行し、検出されたものを変更することをお勧めします。

2. データ レジデンシーの要件をご確認ください。データ レジデンシーの構成は、現在コード コンテキストではサポートされていません。インデックス化されたコードとエンベディングは、米国で保存および処理されます。組織に米国外でのデータ レジデンシーまたはデータ主権の要件がある場合は、コード コンテキストを有効にすることがお客様の状況に適しているか確認してください。データ レジデンシーを理解する

3. インデックス作成権限を確認します。アトラシアンがソース コードをミラーリング、インデックス化、および保存できるようにするために、組織が必要な権利と承認を得ていることを確認してください。

Set up code context for Bitbucket Cloud

Disclaimers (Bitbucket only)

• Automatic indexing and use. Rovo’s ability to answer natural language questions about your codebase is improved through semantic search indexes. When a paid Bitbucket workspace is connected to a Jira site with Rovo enabled (either at the time Rovo is activated or when a workspace is subsequently linked), Atlassian will automatically enable Code context and create a semantic search index of that workspace. Code changes are automatically indexed on an ongoing basis; updates may take up to 6 hours to reflect in search results.

• Data handling and controls. Code context will not use your source code or indexes for model training. Searches will respect existing Bitbucket repository permissions. If used with a third-party coding agent, relevant source-code snippets may be transmitted to that provider and governed by its terms.

Requesting Code context now

Our automatic rollout to Bitbucket customers will complete over the next two months. If you would like to request indexing, please follow these instructions:

1. アトラシアンの管理に移動します。複数の組織がある場合は、対象の組織を選択します。

2. [Rovo] を選択し、次に [コード コンテキスト] を選択します。

3. [コード コンテキストを有効にする] を選択します。

Once enabled, your connected code will immediately start indexing. This can take up to 48 hours. The status of the initial index will be shown in your dashboard.

Set up code context for Github

Install GitHub for Atlassian and connect the GitHub organization

A Jira site administrator must install the GitHub for Atlassian app before Code context. Refer to the following help document for setup guidance with the most up-to-date installation flow: Connect GitHub Cloud to Jira | Atlassian Support

Grant access to Github organizations

To ensure that any private repositories are accessible by the Atlassian Cloud OAuth app, you need to grant access to your Github organization(s), if that has not already been done by a Github admin.

1. To enable the Atlassian Cloud OAuth app, go to github.com/settings/applications.

2. Select the Atlassian Cloud OAuth app, and then select the Grant button associated with the Github organization(s) you want to give the Atlassian Cloud OAuth app access to.

Once you have granted this access, you should see a green checkmark next to Full control of private repositories in Permissions.

Verify the connection

1. In Jira, select Apps, and then select Manage your apps.

2. Select GitHub for Atlassian.

3. Confirm that the intended GitHub organization appears as connected.

4. Confirm that the repository scope is correct.

Enable code context

Once the GitHub connection is established, an Atlassian organization admin can enable code context. To enable code context for your site:

1. 移動 アトラシアンの管理。組織が複数ある場合は、対象の組織を選択します。

2. [Rovo] を選択し、次に [コード コンテキスト] を選択します。

3. [コード コンテキストを有効にする] を選択します。

4. コード コンテキストをセットアップするサイトを選択してください。

5. コードコンテキストを有効にするには、規約を慎重にレビューしてください。

Once enabled, your connected code will immediately start indexing. This can take up to 48 hours. The status of the initial index will be shown in your dashboard.

コード コンテキストはいつでも無効にでき、インデックス作成は直ちに停止します。保存されているすべての埋め込み、インデックス、コード チャンクが削除されます。

If you encounter any problems while installing code context, refresh and try again or refer to the troubleshooting section below.

Permissions and access

コード コンテキストは、後付けではなく基本原則として権限を適用するように構築されており、特にソース コード管理 (SCM) の権限を遵守するように設計されています。コード コンテキストは、SCM 権限で許可されている範囲を超えてユーザーにアクセス権を付与することはありません。

Users will see results only for repositories and branches they already have access to in the source SCM. Atlassian validates permissions at query time against the repository's permission endpoint.

組織管理者がリポジトリのコードコンテキストを有効にした場合、個々のコントリビューターは自身のコードをインデックス作成から除外できません。これは、既存の Bitbucket の語彙検索の動作と一致しています。

チームでのコード コンテキストの使い心地について、ご意見をお聞かせください。フィードバックの共有や問題のレポートは、直接 Rovo チャット から行うか、TWG CLI をご利用の場合はこちらのフォームから行ってください。

Troubleshooting GitHub access for code context

If Rovo returns no code results or only some of the code you expect, try disconnecting then reconnecting your GitHub account.

• Issues during GitHub for Atlassian connection

Refer to the following support document for details on troubleshooting you Github connection: Connect GitHub Cloud to Jira | Atlassian Support

• Not seeing expected search results

This could be caused by a few different things.

1. Confirm that the user has access to that repository. Search results respect repository permissions, so if the user does not have access to that repository, no results will appear.

2. If you’re looking for code in GitHub, verify that the corresponding repository was granted access during the GitHub for Atlassian connection phase. See the official documentation here on repository scopes. Code context will not index repositories that are not connected. Connect GitHub Cloud to Jira | Atlassian Support

3. Confirm that the user has linked their GitHub or Bitbucket identity. This can be connected from Rovo Chat through the Data Sources.

4. Confirm that indexing is complete for the connected repositories. The status of the initial index will be available in the AdminHub to administrators. The initial index can take up to 48 hours.

5. Private repositories are not visible unless the Atlassian Cloud OAuth app is enabled by a Github admin and proper permissions are granted.

   1. To enable the Atlassian Cloud OAuth app, go to github.com/settings/applications, select the Atlassian Cloud OAuth app, and then select the Grant button associated with the Github organization(s) you want to give the Atlassian Cloud OAuth app access to. Once you have granted this access, you should see a green checkmark next to Full control of private repositories in Permissions.

GitHub access for code context

If Rovo returns no code results or only some of the code you expect, try disconnecting then reconnecting your GitHub account.

Disconnect GitHub

To disconnect your account:

1. Go to Manage connected apps.

2. Find Atlassian then GitHub.

3. [削除] を選択します。

Reconnect GitHub

To reconnect your account:

1. Follow the steps to Connect to external apps | Rovo | Atlassian Support to connect GitHub.

2. Use the GitHub account that has access to the repositories you want to search.

3. Wait up to 15 minutes, then try your code context search again.