# シークレットスキャンからのフォルダーとファイルの除外
リポジトリ内のsecret scanning ファイルを構成することで、secret_scanning.ymlをカスタマイズして、特定のディレクトリまたはファイルに含まれるシークレットのアラートを自動的に閉じることができます。
ドキュメントやサンプルアプリケーションで偽のシークレットを提供する場合など、リポジトリにシークレットをコミットする場合が考えられます。 これらのシナリオでは、アラートをすばやく無視して理由を文書化できます。 ただし、大規模な誤検知アラートを作成しないようにするために、ディレクトリを完全に無視することもあります。 たとえば、多数の誤ったアラートをトリアージに発せられる可能性があるダミー キーのファイルを含む複数の統合を持つモノリシック アプリケーションがあるとします。
特定のディレクトリにあるアラートを`secret_scanning.yml`から自動的に閉じ、プッシュ保護に含まれるこれらのディレクトリを除外するように、secret scanning ファイルを構成できます。 これらのアラートは、"構成によって無視された" ものとして閉じられます。
## ユーザーのシークレット スキャン アラート からディレクトリを除外する
1. GitHub で、リポジトリのメイン ページに移動します。
2. ファイルの一覧の上にある **\[Add file ]** ドロップダウン メニューを選んでから、**\[ Create new file]** をクリックします。
または、左側のファイル ツリー ビューの をクリックしてもかまいません。
![上で説明した \[Add file\] と "プラス記号" アイコンの両方がオレンジ色の枠線で強調されている、リポジトリのメイン ページのスクリーンショット。](/assets/images/help/repository/add-file-buttons.png)
3. ファイル名フィールドに「.github/secret\_scanning.yml」と入力します。
4. \[ **新しいファイルの編集]** で、「 `paths-ignore:` 」と入力し、その後に secret scanningから除外するパスを入力します。
```yaml copy
paths-ignore:
- "docs/**"
```
これにより、secret scanning ディレクトリ内のすべてのアラートを自動的に閉じるよう`docs`に指示されます。 このサンプル ファイルをテンプレートとして使用して、独自のリポジトリから除外するファイルとフォルダーを追加できます。
`*` などの特殊文字を使用して、パスをフィルター処理することもできます。 フィルター パターンの詳細については、「[GitHub Actions のワークフロー構文](/ja/actions/reference/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)」を参照してください。
````
``` yaml copy
paths-ignore:
- "foo/bar/*.js"
```
> [!NOTE]
> *
````
`paths-ignore`に 1,000 個を超えるエントリがある場合、secret scanningは最初の 1,000 個のディレクトリのみをスキャンから除外します。
\> \*
`secret_scanning.yml`が 1 MB を超える場合、secret scanningはファイル全体を無視します。
## フォルダーが除外されていることを確認する secret scanning
1. シークレット スキャンから除外したディレクトリ内のファイルを開く
2. 事前に無効化されたシークレットまたはテスト シークレットを貼り付けます。
3. 変更をコミットします。
4. GitHub で、リポジトリのメイン ページに移動します。
5. リポジトリ名の下にある \[ ** Security and quality** ] タブをクリックします。\[ Security and quality] タブが表示されない場合は、 **** ドロップダウン メニューを選択し、\[ ** Security and quality**] をクリックします。 ファイルに導入したシークレットに対する新しいオープン アラートは存在しません。
## ベスト プラクティス
ベスト プラクティスには次のようなものがあります。
* 除外するディレクトリの数を最小限に抑え、除外を定義するときに可能な限り正確にします。 これにより、指示が可能な限り明確になり、除外が想定通りに機能するようになります。
* `secret_scanning.yml` ファイル内のコメントで特定のファイルまたはフォルダーが除外される理由を説明します。 通常のコードと同様に、コメントを使用すると意図が明確になり、他のユーザーが目的の動作を理解しやすくなります。
* `secret_scanning.yml` ファイルを定期的に確認します。 一部の除外は時間と共に適用されなくなる可能性があり、ファイルをクリーンで最新の状態に保つことをお勧めします。 上記で説明したように、コメントを使用することが役立ちます。
* 除外したファイルとフォルダーとその理由をセキュリティ チームに通知します。 すべてのユーザーが同じページに存在し、特定のフォルダーまたはファイルが除外される理由を理解するには、適切なコミュニケーションが不可欠です。