Configuring secret scanning for your repositories

Enabling escaneo de secretos for private repositories

1. En GitHub, visita la página principal del repositorio.

2. Debajo de tu nombre de repositorio, da clic en Configuración.

3. En la barra lateral izquierda, da clic en Seguridad & análisis.

4. If Advanced Security is not already enabled for the repository, to the right of "GitHub Advanced Security", click Enable.

5. Review the impact of enabling Advanced Security, then click Enable GitHub Advanced Security for this repository.

6. When you enable Advanced Security, escaneo de secretos may automatically be enabled for the repository due to the organization's settings. If "Escaneo de secretos" is shown with an Enable button, you still need to enable escaneo de secretos by clicking Enable. If you see a Disable button, escaneo de secretos is already enabled.

Excluding alerts from escaneo de secretos in private repositories

You can use a secret_scanning.yml file to exclude directories from escaneo de secretos. For example, you can exclude directories that contain tests or randomly generated content.

1. En GitHub, visita la página principal del repositorio.

2. En la parte superior de la lista de archivos, utilizando el menú desplegable de Agregar archivo, da clic en Crear archivo nuevo.

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 escaneo de secretos.

   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, escaneo de secretos will only exclude the first 1,000 directories from scans.
   • If secret_scanning.yml is larger than 1 MB, escaneo de secretos will ignore the entire file.

You can also ignore individual alerts from escaneo de secretos. For more information, see "Managing alerts from escaneo de secretos."

Further reading

• "Managing security and analysis settings for your organization"