[](https://api.scorecard.dev/projects/github.com/ossf/allstar)
<img align="right" src="https://assets.kitploit.com/production/public/readmes/4605/56f8714eef22fa31a6956e341013b069f09b7dd1b45c374eec1e6987c911ed49.png" width="300" height="400">
# **Allstar**
> [!IMPORTANT]
> **OpenSSF がホストする Allstar GitHub App は提供終了となりました。**
> OpenSSF Scorecard のサブプロジェクトである Allstar 自体は引き続き
> メンテナンスされていますが、今後はご自身で実行する必要があります。
> [GitHub Action として](#running-allstar-as-a-github-action)実行するか、
> [サービスデーモンとして](#running-allstar-as-a-service-daemon)実行してください。
>
> 詳細については [ossf/allstar#881](https://github.com/ossf/allstar/issues/881) を
> 参照してください。
>
> 組織がホスト版アプリに依存していた場合は、
> [ホスト版アプリからの移行](#migrating-off-the-hosted-app)を参照してください。
## 概要
- [Allstar とは?](#what-is-allstar)
## Allstar の新機能
- [whats-new.md](https://github.com/ossf/allstar/blob/main/whats-new.md)
## 不要な Issue の無効化
- [助けて!Allstar によって Issue が作成されるけど、そんなの欲しくない!](#disabling-unwanted-issues-1)
## はじめに
- [背景](#background)
- [組織レベルのオプション](#org-level-options)
- [インストールオプション](#installation-options)
- [GitHub App の作成](#create-your-github-app)
- [`.allstar` 制御リポジトリの作成](#create-your-allstar-control-repository)
- [Allstar を GitHub Action として実行する](#running-allstar-as-a-github-action)
- [Allstar をサービスデーモンとして実行する](#running-allstar-as-a-service-daemon)
- [ホスト版アプリからの移行](#migrating-off-the-hosted-app)
## ポリシーとアクション
- [アクション](#actions)
- [ポリシー](#policies)
## 上級者向け
- [設定定義](#configuration-definitions)
- [設定例](#example-config-repository)
- [独自の Allstar インスタンスの実行](https://github.com/ossf/allstar/blob/main/operator.md)
## コントリビュート
- [コントリビュート](#contributing)
________
________
## 概要
### Allstar とは?
Allstar は、GitHub の組織やリポジトリがセキュリティのベストプラクティスに
準拠しているかを継続的に監視する GitHub App です。Allstar がセキュリティ
ポリシーの違反を検出すると、リポジトリまたは組織のオーナーに警告するための
Issue を作成します。一部のセキュリティポリシーでは、Allstar は違反の原因と
なったプロジェクト設定を自動的に変更し、期待される状態に戻すこともできます。
Allstar の目標は、プロジェクトのセキュリティに影響するファイルや設定を、
きめ細かく制御できるようにすることです。組織レベルとリポジトリレベルの両方で、
監視するセキュリティポリシーとポリシー違反の処理方法を選択できます。また、
新しいポリシーを開発したり、コントリビュートしたりすることもできます。
Allstar は [OpenSSF Scorecard](https://github.com/ossf/scorecard) プロジェクトの
一部として開発されています。
## [Allstar の新機能](https://github.com/ossf/allstar/blob/main/whats-new.md)
## 不要な Issue の無効化
Allstar によって不要な Issue が作成されている場合は、[こちらの手順](https://github.com/ossf/allstar/blob/main/opt-out.md)に従ってオプトアウトしてください。
## はじめに
### 背景
Allstar は高度に設定可能です。主に 3 つの制御レベルがあります。
- **組織レベル**: 組織の管理者は、Allstar を有効にする対象を選択できます。
- 組織内のすべてのリポジトリ。
- 一部のオプトアウトされたリポジトリを除く、ほとんどのリポジトリ。
- オプトインされた一部のリポジトリのみ。
これらの設定は、組織の `.allstar` リポジトリで行います。
- **リポジトリレベル:** Allstar を使用する組織内のリポジトリメンテナーは、
自身のリポジトリを組織レベルの適用対象にオプトインまたはオプトアウト
できます。注: これらのリポジトリレベルの制御は、組織レベルの設定で
「リポジトリによる上書き」が許可されている場合にのみ機能します。これらの
設定は、リポジトリの `.allstar` ディレクトリで行います。
- **ポリシーレベル:** 管理者またはメンテナーは、特定のリポジトリで有効にする
ポリシーと、ポリシー違反時に Allstar が実行するアクションを選択できます。
これらの設定は、組織の `.allstar` リポジトリ(管理者)またはリポジトリの
`.allstar` ディレクトリ(メンテナー)にあるポリシー yaml ファイルで行います。
### 組織レベルのオプション
組織レベルで Allstar をインストールする前に、Allstar を実行するリポジトリの概算数を決めておく必要があります。これにより、オプトイン戦略とオプトアウト戦略のどちらを選ぶかを判断しやすくなります。
- オプトイン戦略では、Allstar を実行したいリポジトリを手動で追加します。リポジトリを何も指定しない場合、Allstar はインストールされていても実行されません。全リポジトリのうちごく少数のリポジトリにのみポリシーを適用したい場合や、有効化する前に単一のリポジトリで Allstar を試したい場合にオプトイン戦略を選択してください。v4.3 リリース以降、類似した名前の複数リポジトリを簡単に追加できる glob がサポートされています。
- オプトアウト戦略(推奨)では、すべてのリポジトリで Allstar が有効になり、Allstar の適用から除外するリポジトリを手動で選択できます。すべてのパブリックリポジトリ、またはすべてのプライベートリポジトリを除外することもできます。組織内のすべてのリポジトリで Allstar を実行したい場合や、ごく少数のリポジトリ、または特定の種類(パブリックかプライベートか)のリポジトリのみを除外したい場合にこのオプションを選択してください。v4.3 リリース以降、類似した名前の複数リポジトリを簡単に追加できる glob がサポートされています。
<table>
<thead>
<tr>
<th></th>
<th><strong>オプトアウト(推奨)</strong><br>
<strong>optOutStrategy = true</strong></th>
<th><strong>オプトイン</strong><br>
<strong>optOutStrategy = false</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>デフォルトの動作 </td>
<td>すべてのリポジトリが有効</td>
<td>どのリポジトリも有効にならない </td>
</tr>
<tr>
<td>リポジトリの手動追加</td>
<td>リポジトリを手動で追加すると、それらのリポジトリで Allstar が無効になる</td>
<td>リポジトリを手動で追加すると、それらのリポジトリで Allstar が有効になる</td>
</tr>
<tr>
<td>追加の設定</td>
<td>optOutRepos: リストされたリポジトリで Allstar が無効になる<br>
<br>
optOutPrivateRepos: true の場合、すべてのプライベートリポジトリで Allstar が無効になる
<br>
<br>
optOutPublicRepos: true の場合、すべてのパブリックリポジトリで Allstar が無効になる<br>
<br>
(optInRepos: この設定は無視される)</td>
<td>optInRepos: リストされたリポジトリで Allstar が有効になる <br>
<br>
(optOutRepos: この設定は無視される)</td>
</tr>
<tr>
<td>リポジトリによる上書き </td>
<td>true の場合: リポジトリは自身のリポジトリファイル内の設定を使用して、組織の Allstar 適用からオプトアウトできる。そのリポジトリに適用される組織レベルのオプトイン設定は無視される。 <br>
<br>
false の場合: リポジトリは組織レベルで設定された Allstar の適用からオプトアウトできない。 </td>
<td>true の場合: リポジトリは組織レベルでそのリポジトリ向けに設定されていなくても、組織の Allstar 適用にオプトインできる。そのリポジトリに適用される組織レベルのオプトアウト設定は無視される。<br>
<br>
false の場合: リポジトリは組織レベルで設定されていない限り、Allstar の適用にオプトインできない。 </td>
</tr>
</tbody>
</table>
### インストールオプション
Allstar は GitHub App として組織に対して動作します。アプリを作成し、そのアプリとして認証するプロセスを実行します。したがって、セットアップはすべてのデプロイに共通する 2 つのステップ — [アプリの作成](#create-your-github-app) と [コントロールリポジトリの作成](#create-your-allstar-control-repository) — に加えて、実行方法の選択からなります:
| | [GitHub Action](#running-allstar-as-a-github-action) | [サービスデーモン](#running-allstar-as-a-service-daemon) |
|---|---|---|
| **実行方法** | `.allstar` リポジトリ内のスケジュールされたジョブ | 自身でホストする常駐プロセス |
| **用意するもの** | GitHub 以外には何も不要 | サーバーまたはコンテナオーケストレーター |
| **実行頻度** | `cron` に設定したとおり | 継続的で、結果は 5〜10 分で得られる |
| **セットアップの手間** | 中程度 | 高い |
| **適している場合** | インフラを最小限にしたい場合 | 最大限の制御を望む場合、またはすでにサービスを運用している場合 |
Action は 2 つのうちオーバーヘッドが小さく、ほとんどの組織はここから始めるべきです。ポリシー設定を変更することなく、後からデーモンに移行できます。
#### GitHub App の作成
App は、組織内で一連の権限を持つユーザーのような ID です。Allstar はコンプライアンスを検出するためにほとんどの設定とファイル内容への読み取りアクセスを必要とし、issue を起票して `block` アクションをサポートするために issue とチェックへの書き込みアクセスを必要とします。
[Operator instructions - Create a GitHub
App](https://github.com/ossf/allstar/blob/main/operator.md#create-a-github-app) に従い、App ID と秘密鍵を記録してください。どちらの実行モードでもこれらが必要です。
#### `.allstar` 制御リポジトリを作成する
Allstar は、組織内の `.allstar` という名前のリポジトリから設定を読み取ります。
最も簡単に作成する方法は、サンプルから作成することです:
1. [サンプルリポジトリを開き](https://github.com/ossf/dot-allstar-quickstart)、「Use this template」ボタンをクリックします
1. Repository Name のフィールドに `.allstar` と入力します
1. 「Create repository from template」をクリックします
これにより、Opt Out 戦略を使用して、`issue` アクションで、すべてのリポジトリに対して現在のすべての Allstar [ポリシー](#policies)が有効になります。後からいつでも変更できます。
最初からきめ細かく制御する場合 — Opt In または Opt Out 戦略を選択し、個々のポリシーファイルを自分で記述する場合 — は、代わりに[手動インストール手順](https://github.com/ossf/allstar/blob/main/manual-install.md)に従ってください。
#### Allstar を GitHub Action として実行する
このオプションは、GitHub Actions を使用して Allstar をスケジュールされたジョブとして実行するため、GitHub 自体以外に運用するインフラストラクチャはありません。
[GitHub Actions インストール手順](https://github.com/ossf/allstar/blob/main/github-action-installation.md)に従って、`.allstar` リポジトリで定期的な Action を設定し、それを強化し、その結果を監視してください。
#### Allstar をサービスデーモンとして実行する
このオプションは、Allstar を常駐プロセスとして実行し、スケジュールではなく継続的に違反を検出して解決します。
プロセスの実行、シークレットの管理、サイジング、および利用可能な環境変数については、[Operator instructions](https://github.com/ossf/allstar/blob/main/operator.md)を参照してください。
### ホスト型アプリからの移行
組織が OpenSSF ホスト型アプリを使用していた場合、**設定はそのまま引き継がれます**。`.allstar` 制御リポジトリ、`allstar.yaml`、およびすべてのポリシーファイルは変更なしで動作し続けます。置き換えるのは、それらを読み取るプロセスのみです。
移行するには:
1. [独自の GitHub App を作成](#create-your-github-app)し、ホスト型アプリと同じリポジトリアクセス権で組織にインストールします。
1. 既存の `.allstar` リポジトリをそのまま維持します。
1. Allstar を [Action として](#running-allstar-as-a-github-action)または[デーモンとして](#running-allstar-as-a-service-daemon)実行します。
1. `allstar-app` がまだ Settings -> GitHub Apps に表示される場合は、組織からアンインストールします。
ホスト型アプリによって以前に起票された issue は、リポジトリに残ります。独自のインスタンスは、同じ `allstar` ラベル(または設定した `issueLabel`)で issue を識別するため、違反が解決されると重複して起票するのではなく、それらを引き継いでクローズします。
## ポリシーとアクション
## **アクション**
各ポリシーは、Allstar がリポジトリのコンプライアンス違反を検出したときに実行するアクションで設定できます。
- `log`: これはデフォルトのアクションであり、実際にはすべてのアクションで実行されます。すべてのポリシー実行結果と詳細がログに記録されます。ログは現在アプリのオペレーターのみが閲覧でき、これを公開する計画は議論中です。
- `issue`: このアクションは GitHub issue を作成します。ポリシーごとに作成される issue は 1 つだけで、そのテキストにはポリシー違反の詳細が記述されます。issue がすでにオープンしている場合、更新がない限り 24 時間ごとにコメントで通知されます(現在はユーザー設定不可)。ポリシーの結果が変わった場合、新しいコメントが issue に残され、issue 本文にリンクされます。違反が対処されると、issue は Allstar によって 5〜10 分以内に自動的にクローズされます。
- `fix`: このアクションはポリシー固有です。ポリシーは、ポリシー違反を修正するために GitHub 設定を変更します。すべてのポリシーがこれをサポートできるわけではありません(以下を参照)。
提案済みだがまだ実装されていないアクション。定義は将来追加されます。
- `block`: Allstar は [GitHub ステータスチェック](https://docs.github.com/en/github/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)を設定し、チェックが失敗した場合にリポジトリ内の PR がマージされるのをブロックできます。
- `email`: Allstar はリポジトリ管理者にメールを送信します。
- `rpc`: Allstar は組織固有のシステムに rpc を送信します。
### **アクション設定**
issue アクションを設定するための 2 つの設定が利用可能です:
- `issueLabel` は組織レベルとリポジトリレベルで利用可能です。設定すると、Allstar が自身の issue を識別するために使用するデフォルトの `allstar` ラベルが上書きされます。
- `issueRepo` は組織レベルで利用可能です。設定すると、組織内で作成されるすべての issue が指定されたリポジトリ内に作成されるようになります。
## **ポリシー**
Allstar アプリの有効化設定と同様に、すべてのポリシーは組織の `.allstar` リポジトリ、またはリポジトリの `.allstar` ディレクトリ内の yaml ファイルで有効化および設定されます。アプリと同様に、ポリシーはデフォルトでオプトインであり、またデフォルトの `log` アクションでは目に見える結果は生成されません。すべてのポリシーを有効化する簡単な方法は、各ポリシー用の yaml ファイルを以下の内容で作成することです:
```yaml
optConfig:
optOutStrategy: true
action: issue
```
各ポリシーにおける `fix` アクションの動作の詳細を以下に説明します。以下に記載がない場合、`fix` アクションは適用できません。
### ブランチ保護
このポリシーの設定ファイルは `branch_protection.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/branch#OrgConfig)にあります。
ブランチ保護ポリシーは、GitHub の[ブランチ保護設定](https://docs.github.com/en/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)が指定された構成に従って正しく設定されているかを確認します。イシューの本文には、どの設定が正しくないかが記載されます。設定の修正方法については [GitHub のドキュメント](https://docs.github.com/en/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)を参照してください。
`fix` アクションは、ブランチ保護設定を指定されたポリシー構成に準拠するように変更します。
### バイナリアーティファクト
このポリシーの設定ファイルは `binary_artifacts.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/binary#OrgConfig)にあります。
このポリシーは [scorecard のチェック](https://github.com/ossf/scorecard/#scorecard-checks)を取り入れています。準拠するには、リポジトリからバイナリアーティファクトを削除してください。scorecard の結果は冗長になる場合があるため、詳細情報をすべて確認するには [scorecard 自体](https://github.com/ossf/scorecard)を実行する必要があるかもしれません。
### CODEOWNERS
このポリシーの設定ファイルは `codeowners.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/codeowners#OrgConfig)にあります。
このポリシーは、リポジトリに [`CODEOWNERS` ファイル](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)が存在するかどうかを確認します。
### 外部コラボレーター
このポリシーの設定ファイルは `outside.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/outside#OrgConfig)にあります。
このポリシーは、[外部コラボレーター](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)がリポジトリに対して管理者権限(デフォルト)またはプッシュ権限(オプション)を持っているかどうかを確認します。この権限は組織のメンバーのみが持つべきです。そうでなければ、信頼されていないメンバーが管理者レベルの設定を変更したり、悪意のあるコードをコミットしたりできるからです。
### SECURITY.md
このポリシーの設定ファイルは `security.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/security#OrgConfig)にあります。
このポリシーは、リポジトリに `SECURITY.md` 内のセキュリティポリシーファイルが存在し、それが空でないことを確認します。作成されるイシューには、リポジトリにセキュリティポリシーをコミットするのに役立つ [GitHub タブ](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)へのリンクが含まれます。
### シークレットスキャン
このポリシーの設定ファイルは `secret_scanning.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/secretscanning#OrgConfig)にあります。
このポリシーは、シークレットスキャンに関する GitHub リポジトリの設定を確認します。GitHub が無効であると報告した場合、作成されるイシューはリポジトリのセキュリティ設定に直接リンクします。API がシークレットスキャンのステータスを返さない場合、ポリシーはそれを無効として扱うのではなく、ステータスが利用不可であることを記録します。
`fix` アクションは、まだ有効になっていないリポジトリに対して GitHub のシークレットスキャンを有効にします。Allstar GitHub App が GitHub API でこの設定を読み取ったり変更したりするには、リポジトリの管理権限が必要です。
### 危険なワークフロー
このポリシーの設定ファイルは `dangerous_workflow.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/workflow#OrgConfig)にあります。
このポリシーは **すべて** のブランチに対して実行されます。根拠については[こちら](https://github.com/ossf/allstar/issues/569)を参照してください。
このポリシーは、GitHub Actions のワークフロー設定ファイル
(`.github/workflows`) を検査し、既知の危険な動作に一致するパターンがないかを確認します。このチェックの詳細については、[OpenSSF Scorecard
ドキュメント](https://github.com/ossf/scorecard/blob/main/docs/checks.md#dangerous-workflow)
を参照してください。
### 汎用 Scorecard チェック
このポリシーの設定ファイルは `scorecard.yaml` という名前で、[設定定義は
こちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/scorecard#OrgConfig)にあります。
このポリシーは、`checks` 設定に記載された任意の scorecard チェックを実行します。実行されるすべての
チェックは、`threshold` 設定以上のスコアを持つ必要があります。各チェックの詳細については、
[OpenSSF Scorecard
ドキュメント](https://github.com/ossf/scorecard/blob/main/docs/checks.md)
を参照してください。
#### SARIF アップロード
Scorecard ポリシーは、オプションで結果を
[SARIF](https://sarifweb.azurewebsites.net/) として各リポジトリの
**Security > Code Scanning** タブにアップロードできます。これにより、組織の管理者は
リポジトリごとのワークフロー設定を必要とせずに、他のセキュリティツール (CodeQL、
Dependabot など) と並べて Scorecard の検出結果を可視化できます。
SARIF アップロードを有効にするには、`scorecard.yaml` に `upload` フィールドを追加します:
```yaml
optConfig:
optOutStrategy: true
action: issue
checks:
- Binary-Artifacts
- Signed-Releases
threshold: 8
upload:
sarif: true
```
**要件:**
- Allstar GitHub App は、**Code scanning alerts** リポジトリ権限を **Read & write** に設定する必要があります(API スコープ: `security_events`)。これは Allstar が通常必要とする権限には含まれていないため、SARIF アップロードを有効にする前にアプリに追加してください。
- SARIF アップロードは非ブロッキングです。アップロードが失敗した場合(権限不足など)、ポリシーチェックは通常どおり続行されます。
- 変更検出はリポジトリの HEAD コミット SHA を比較し、前回のアップロード以降にリポジトリへプッシュされていない場合はスキャンとアップロードをスキップします。
SARIF アップロードは、Allstar の両方の実行方法で動作します: [サービスデーモン](https://github.com/ossf/allstar/blob/main/operator.md) として、または [GitHub Action](https://github.com/ossf/allstar/blob/main/github-action-installation.md) として。
### GitHub Actions
このポリシーの設定ファイルは `actions.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/action#OrgConfig)にあります。
このポリシーは、各リポジトリ内の GitHub Actions ワークフロー設定ファイル(`.github/workflows`)(および場合によってはワークフロー実行)をチェックし、ポリシーの組織レベル設定で定義されたルール(例: require、deny)に準拠していることを確認します。
### Repository Administrators
このポリシーの設定ファイルは `admin.yaml` という名前で、[設定定義はこちら](https://pkg.go.dev/github.com/ossf/allstar/pkg/policies/admin#OrgConfig)にあります。
このポリシーは、デフォルトですべてのリポジトリに管理者としてユーザーまたはグループが割り当てられていることをチェックします。オプションで、ユーザーが管理者になることを許可するかどうか(チームではなく)を設定できます。
### 今後のポリシー
- dependabot が有効になっていることを確認する。
- 依存関係が固定/凍結されていることをチェックする。
## **設定リポジトリの例**
Allstar 設定が使用されている例として[このリポジトリ](https://github.com/GoogleContainerTools/.allstar)を参照してください。組織の管理者として、組織内で Allstar がどのように使用されているかに関する情報を含む README.md を検討してください。
## 高度な設定
### 設定定義
- [組織レベルの有効化設定](https://pkg.go.dev/github.com/ossf/allstar/pkg/config#OrgOptConfig)
- [リポジトリオーバーライドの有効化設定]( https://pkg.go.dev/github.com/ossf/allstar/pkg/config#RepoOptConfig)
### セカンダリの組織レベル設定場所
デフォルトでは、上記の `allstar.yaml` ファイルなどの組織レベル設定ファイルは `.allstar` リポジトリにあることが想定されています。このリポジトリが存在しない場合、`.github` リポジトリの `allstar` ディレクトリがセカンダリの場所として使用されます。明確にするため、`allstar.yaml` について示します:
| 優先順位 | リポジトリ | パス |
| - | - | - |
| プライマリ | `.allstar` | `allstar.yaml` |
| セカンダリ | `.github` | `allstar/allstar.yaml` |
これは、以下で説明する個々のポリシーの組織レベル設定ファイルについても同様です。
### 組織リポジトリ内のリポジトリポリシー設定
Allstar は、組織の `.allstar` リポジトリ内で、リポジトリと同じ名前のディレクトリの下にあるリポジトリレベルのポリシー設定も探します。この設定は、「リポジトリオーバーライド」が無効になっているかどうかに関係なく使用されます。
例えば、Allstar は特定のリポジトリ `myapp` のポリシー設定を次の順序で検索します:
| リポジトリ | パス | 条件 |
| - | - | - |
| `myapp` | `.allstar/branch_protection.yaml` | 「リポジトリオーバーライド」が許可されている場合。 |
| `.allstar` | `myapp/branch_protection.yaml` | 常に。 |
| `.allstar` | `branch_protection.yaml` | 常に。 |
| `.github` | `allstar/myapp/branch_protection.yaml` | `.allstar` リポジトリが存在しない場合。 |
| `.github` | `allstar/branch_protection.yaml` | `.allstar` リポジトリが存在しない場合。 |
### 組織レベルのベースおよびマージ設定場所
組織レベルの Allstar およびポリシー設定ファイルでは、フィールド `baseConfig` を指定して、ベースの Allstar 設定を含む別のリポジトリを指定できます。これは例で説明するのが最もわかりやすいでしょう。
複数の GitHub 組織を持っているが、単一の Allstar 設定を維持したいとします。メインの組織は「acme」で、リポジトリ `acme/.allstar` には `allstar.yaml` が含まれています:
```yaml
optConfig:
optOutStrategy: true
issueLabel: allstar-acme
issueFooter: Issue created by Acme security team.
```
また、"acme-sat" という名前のサテライト GitHub 組織もあります。メインの設定を再利用しつつ、特定のリポジトリで Allstar を無効化することで、その上にいくつかの変更を適用したいと考えています。リポジトリ `acme-sat/.allstar` には `allstar.yaml` が含まれています:
```yaml
baseConfig: acme/.allstar
optConfig:
optOutRepos:
- acmesat-one
- acmesat-two
```
これにより、`acme/.allstar` のすべての設定がベース設定として使用され、そのベース設定の上に現在のファイルの変更が適用されます。適用方法は [JSON Merge Patch](https://datatracker.ietf.org/doc/html/rfc7396) として記述されています。`baseConfig` は GitHub の `<org>/<repository>` である必要があります。
## **コントリビューション**
[CONTRIBUTING.md](https://github.com/ossf/allstar/blob/main/CONTRIBUTING.md) を参照してください。