組織内リポジトリのカスタム プロパティの管理

カスタム プロパティを使用すると、組織内のリポジトリにメタデータを追加できます。 これらのプロパティを使用して、ルールセットを含むリポジトリをターゲットにすることができます。

この機能を使用できるユーザーについて

Organization owners and users with the "Manage the organization's custom properties definitions" permission can add and set a custom property schema at the organization level.

この記事の内容

カスタム プロパティについて

カスタム プロパティを使用すると、コンプライアンス フレームワーク、データの機密性、プロジェクトの詳細などの情報でリポジトリを修飾できます。 カスタム プロパティはプライベートであり、リポジトリに対する読み取りアクセス許可を持つユーザーのみが閲覧できます。

リポジトリのプロパティを使用して、ルールセットでターゲットにするリポジトリを決定できます。 詳しくは、「組織内のリポジトリのルールセットを作成する」を参照してください。

使用できる文字

カスタム プロパティの名前と値には、特定の文字のみを含めることができます。

  • 名前: a-z、A-Z、0-9、_、-、$、#
  • 値: 印刷可能なすべての ASCII 文字。ただし " を除きます。

カスタム プロパティの追加

組織にカスタム プロパティを追加し、組織内リポジトリのこれらのプロパティの値を設定できます。

REST API を使用して organization のカスタム プロパティの作成と管理を行うこともできます。 詳しくは、「カスタム プロパティの REST API エンドポイント」をご覧ください。

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. 組織の隣の [設定] をクリックします。

  3. 左のサイド バーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、 [カスタム プロパティ] をクリックします。

    組織の設定ページのスクリーンショット。 サイドバーでは、[カスタム プロパティ] というラベルの付いたリンクがオレンジ色の枠線で囲まれています。

  4. 新しいカスタム プロパティを追加するには、右上隅にある **[新しいプロパティ] ** をクリックします。

  5. "名前" フィールドに、カスタム プロパティに使用する名前を入力します。 名前にスペースを含めることはできません。

  6. 必要に応じて、"説明" フィールドにカスタム プロパティの説明を入力します。

  7. [種類] で、追加するプロパティの種類を選択します。 これは、テキスト文字列、単一選択フィールド、複数選択フィールド、または true/false ブール値のいずれかです。

  8. 必要に応じて、[リポジトリ アクターがこのプロパティを設定することを許可する] を選択できます。 有効にすると、リポジトリ レベルの "カスタム プロパティ" 詳細に設定されたアクセス許可を持つリポジトリ ユーザーとアプリは、リポジトリのプロパティ値を設定および更新できます。

  9. 必要に応じて、[すべてのリポジトリにこのプロパティを必須にする] を選択し、既定値を追加できます。 こうすると、組織内のすべてのリポジトリにこのプロパティの値が必須になりす。 このプロパティに明示的な値がないリポジトリは、既定値を継承します。

  10. [プロパティの保存] をクリックします。

組織内リポジトリの値の設定

と、"組織レベルでカスタム プロパティ値を編集する" アクセス許可を持つすべてのユーザーは、 が組織のリポジトリのカスタム プロパティ値を設定できます。

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。

  2. 組織の隣の [設定] をクリックします。

  3. 左のサイド バーの [コード、計画、自動化] セクションで、[ リポジトリ] をクリックし、 [カスタム プロパティ] をクリックします。

    組織の設定ページのスクリーンショット。 サイドバーでは、[カスタム プロパティ] というラベルの付いたリンクがオレンジ色の枠線で囲まれています。

  4. [値の設定] タブをクリックします。

  5. リストから 1 つまたは複数のリポジトリを選択し、 [プロパティの編集] をクリックします。

    リポジトリの値を設定するページのスクリーンショット。 鉛筆アイコンと [プロパティの編集] のラベルが付いたボタンが、オレンジ色の枠線でハイライトされています。

  6. 表示されるモーダル ダイアログで、選択したリポジトリに設定する各プロパティの値を選択します。

  7. [変更を保存] をクリックします。

組織内リポジトリの値の表示

リポジトリに対する読み取りアクセス許可を持つユーザーは、そのリポジトリのカスタム プロパティの値を閲覧できますが、それらの値を編集することはできません。

REST API を使用して、organization によってリポジトリに割り当てられたカスタム プロパティを一覧表示することもできます。 詳しくは、「カスタム プロパティの REST API エンドポイント」をご覧ください。

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  3. サイドバーの [Code and automation] セクションで、 [Custom properties] をクリックします。

カスタム プロパティ値によるリポジトリの検索とフィルター処理

カスタム プロパティ値により、組織内のリポジトリを検索できます。

  1. GitHub の右上隅で、プロフィール写真を選択し、 あなたの組織をクリックします。
  2. Organizationの名前をクリックしてください。
  3. 組織名の下の [リポジトリ] をクリックします。
  4. 検索バーに、組織内のすべてのカスタム プロパティのリストを表示するために「prop」と入力し、検索するプロパティを選択します。