カスタム プロパティを使用すると、コンプライアンス フレームワーク、データの機密性、プロジェクトの詳細などの情報でリポジトリを修飾できます。 カスタム プロパティはプライベートであり、リポジトリに対する読み取りアクセス許可を持つユーザーのみが閲覧できます。 Enterprise は最大 100 個のプロパティ定義を設定できます。 許可値リストには最大 200 個の項目を含めることができます。
Enterprise レベルでカスタム プロパティを定義すると、一貫性のある値を作成し、それをユーザーがリポジトリに適用できるようになります。 カスタム プロパティを設定すると、特定のプロパティを持つリポジトリを対象とするルールセット またはリポジトリ ポリシー を作成することで、エンタープライズ内のリポジトリ間で一貫したガバナンスを適用できます。
使用できる文字
カスタム プロパティの名前と値には、特定の文字のみを含めることができます。
- 名前:
a-z、A-Z、0-9、_、-、$、# - 値: 印刷可能なすべての ASCII 文字 (ただし、
"
私が定義したカスタム プロパティの値を設定および表示できるのは誰ですか?
カスタム プロパティを定義すると、ユーザーは Enterprise 内のリポジトリでそのプロパティの値を設定できるようになります。 「Organization 内リポジトリのカスタム プロパティの管理」を参照してください。
- Enterprise 所有者は、必要なプロパティの既定値を設定できます。
- Organization 所有者は、リポジトリ全体またはリポジトリ レベルで organization 内の値を設定できます。
- 有効にした場合、リポジトリ アクセス許可または
custom propertiesの微調整されたアクセス許可を持つユーザーは、リポジトリのプロパティ値を設定および更新できます。
リポジトリに対して読み取りアクセス許可を持つユーザーは、そのリポジトリのカスタム プロパティ値を表示できます。
さらに、organization 所有者は、カスタム プロパティ値を使って organization 内のリポジトリを検索できます。 「Organization 内リポジトリのカスタム プロパティの管理」を参照してください。
カスタム プロパティの提案について
メモ
Copilot リポジトリカスタムプロパティ定義の提案は パブリック プレビューにあります。
単一選択プロパティまたは複数選択プロパティを作成する場合は、プロパティ定義に使用できる値 Copilot 提案できます。 候補を選択して、許可される値の一覧に追加します。
この機能は、 Copilot Business または Copilot Enterpriseで使用できます。 既定では、提案はエンタープライズ レベルのプロパティに対して有効になっており、各組織は提案を有効にするかどうかを決定できます。 代わりに、エンタープライズ所有者は 、リポジトリのカスタム プロパティ の提案ポリシーを使用して、どこでも提案を有効または無効にすることができます。 「企業での GitHub Copilot のポリシーと機能の管理」を参照してください。
カスタム プロパティと外部システムの同期
メモ
外部カスタム プロパティは パブリック プレビュー であり、変更される可能性があります。
ソフトウェア カタログや内部開発者ポータルなどの外部システムから、 GitHubのリポジトリ カスタム プロパティにメタデータを自動的に書き込むことができます。 これにより、外部システムがこれらのプロパティの信頼できるソースになり、所有権、サービス レベル、コンプライアンスの状態などのビジネス コンテキストをリポジトリ内で最新の状態に保つことができます。 外部プロパティは、 GitHubで管理されるカスタム プロパティと同じ場所で使用できます。
外部カスタム プロパティは、組織ごとに個別に構成されます。 セットアップの手順については、「カスタム プロパティと外部システムの統合」をご覧ください。
カスタム プロパティの追加 GitHub
エンタープライズにカスタム プロパティを追加して、すべての組織でこれらのプロパティを使用できるようにすることができます。
-
企業ページに移動してください。 たとえば、GitHub.com の [Enterprise] ページから。
-
左側のサイドバーの [Policies] で、[Custom properties] をクリックします。
-
新しいカスタム プロパティを追加するには、右上隅にある [New property] をクリックします。
-
カスタム プロパティの名前、説明、型を入力します。 名前は、すべての組織で一意である必要があり、スペースを含めることはできません。また、長さが 75 文字を超えることはできません。
1 つの選択または複数選択の種類を選択した場合、プロパティ定義に使用できる値 Copilot 提案できます。 [Accept suggestion](提案を受け入れる) 選択して、許可された値の一覧に追加します。
-
必要に応じて、[Allow repository actors to set this property] を選びます。 有効にすると、リポジトリ レベルの
custom properties詳細に設定されたアクセス許可を持つリポジトリ ユーザーとアプリは、リポジトリのプロパティ値を設定および更新できます。 さらに、リポジトリを作成するすべてのアクターは、リポジトリにプロパティを設定できます。 -
必要に応じて、[Require this property for all repositories] を選び、既定値を追加できます。 こうすると、Enterprise 内のすべてのリポジトリにこのプロパティの値が必須になりす。 このプロパティに明示的な値がないリポジトリは、既定値を継承します。
- 必要に応じて、[ ユーザー指定の明示的な値を要求する] を選択できます。 このオプションを有効にすると、プロパティ値を設定する権限を持つユーザーとアプリは、プロパティの設定、リポジトリの作成、またはリポジトリの転送時に明示的な値を提供する必要があります。 まだ明示的な値を持たないリポジトリは、引き続き既定値を継承します。
-
[プロパティの保存] をクリックします。
組織のプロパティを Enterprise プロパティに昇格する
プロパティを組織から Enterprise アカウントに昇格させて、プロパティ名と値を Enterprise 内のすべての組織で使用できるようにします。
- 企業ページに移動してください。 たとえば、GitHub.com の [Enterprise] ページから。
- 左側のサイドバーの [Policies] で、[Custom properties] をクリックします。
- 組織が管理するすべてのプロパティを表示するには、[フィルター] を選択し、修飾子 Managed by と値として [組織] を選択するか、フィルター バーに
managed-by:organizationと入力します。 - 必要に応じて、特定の組織が管理するプロパティを表示するには、[フィルター] を選択して、修飾子 Organization と値として組織名を選択するか、フィルター バーに
org:<ORGANIZATION-NAME>と入力します。 - プロパティの一覧から、昇格させるプロパティ名を選びます。 プロパティの詳細ページが表示されます。
- 選択したプロパティを昇格させるには、[Enterprise に昇格] をクリックします。 プロパティ名は、エンタープライズ内のすべての組織で一意である必要があります。そうでない場合、昇格できません。
- [昇格] をクリックします。