Configuring secret scanning for your repositories

Enabling 秘密扫描 for repositories

You can enable 秘密扫描 for any repository that is owned by an organization. Once enabled, 秘密扫描 将在 GitHub 仓库中存在的所有分支上扫描整个 Git 历史记录的任何密钥。

1. 在 your GitHub Enterprise Server instance 上，导航到仓库的主页面。

2. 在仓库名称下，单击 Settings（设置）。

3. 在左侧边� �中，单击 Security & analysis（安全和分析）。

4. To the right of "秘密扫描", click Enable.

Excluding alerts from 秘密扫描 in repositories

You can use a secret_scanning.yml file to exclude directories from 秘密扫描. For example, you can exclude directories that contain tests or randomly generated content.

1. 在 your GitHub Enterprise Server instance 上，导航到仓库的主页面。

2. 在文件列表上方，使用 Add file（添� 文件）下拉菜单，单击 Create new file（创建新文件）。

3. In the file name field, type .github/secret_scanning.yml.

4. Under Edit new file, type paths-ignore: followed by the paths you want to exclude from 秘密扫描.

   paths-ignore:
     - "foo/bar/*.js"
   

   You can use special characters, such as * to filter paths. For more information about filter patterns, see "Workflow syntax for GitHub Actions."

   Notes:

   • If there are more than 1,000 entries in paths-ignore, 秘密扫描 will only exclude the first 1,000 directories from scans.
   • If secret_scanning.yml is larger than 1 MB, 秘密扫描 will ignore the entire file.

You can also ignore individual alerts from 秘密扫描. For more information, see "Managing alerts from 秘密扫描."

Further reading

• "Managing security and analysis settings for your organization"