カスタム プロパティとは
カスタム プロパティは、 GitHub.comのリポジトリまたは組織にアタッチできる構造化メタデータ フィールドです。 これにより、コンプライアンス フレームワーク、データの機密性、プロジェクトの詳細などの情報を使用して、リポジトリまたは組織を装飾できます。
カスタム プロパティには、次の 2 種類があります。
- リポジトリのカスタム プロパティ: 個々のリポジトリにアタッチされたメタデータ。
- 組織のカスタム プロパティ: 企業内の組織にアタッチされたメタデータ。
カスタム プロパティを使用する利点は何ですか?
改善された検出、自動化されたワークフロー、コンプライアンス追跡、対象となるポリシーの適用、およびより優れたレポート機能を提供するだけでなく、カスタム プロパティを使用すると、 ルールセット統合による強力なガバナンスが可能になります。
リポジトリと組織のカスタム プロパティの両方をルールセットのターゲット条件として使用でき、メタデータに基づいてきめ細かなポリシー適用を有効にすることができます。
- リポジトリのカスタム規則については、 組織内のリポジトリのルールセットを作成する および Enterprise 内でリポジトリのカスタム プロパティを管理する に関するセクションを参照してください。
- 組織のカスタムルールについては、 Enterprise 内のリポジトリのコード ルールセットを管理する を参照してください。
カスタム プロパティを追加および管理する方法
カスタム プロパティを管理するには、複数の方法があります。 GitHub内のプロパティを管理するには、次を使用できます。
- 組織または企業の設定。 「Organization 内リポジトリのカスタム プロパティの管理」と「組織のカスタム プロパティの管理」を参照してください。
- GitHubのカスタム プロパティの REST API エンドポイント。
また、ソフトウェア カタログや内部開発者ポータルなどの外部システムのメタデータを使用してカスタム プロパティを自動的に更新するように統合を設定することもできます。 外部プロパティは、標準リポジトリのカスタム プロパティと同じ場所で使用できます。 「カスタム プロパティと外部システムの統合」を参照してください
標準のカスタム プロパティと外部プロパティはどちらも、REST API と GitHub Appsを使用して大規模に管理できます。 外部プロパティは、外部システムが真実のソースである必要がある場合に適しています。次の理由から、
- 名前空間付き (
external_system.property_name) であるため、出所が明確で、組織内の他のカスタムプロパティと競合しません。 - GitHubの読み取り専用であるため、ユーザーは編集したり、外部システムと一線を越えて表示したりすることはできません。
外部プロパティは、組織のカスタム プロパティ (組織にアタッチされたメタデータ) では使用 できません 。