socket.yml

Optional Socket GitHub App configuration file

You can optionally configure the Socket GitHub app by adding a socket.yml file to the root of your repo.

ignore:
  - ignored-folder
  - foo/bar/package.json

# enable/disable the Socket.dev GitHub app entirely
enabled: true

# enable/disable GitHub app pull request alert checks
pullRequestAlertsEnabled: true

# enable/disable Github app project report checks
projectReportsEnabled: true

# beta opt in field
beta: false

🚧

Note

The socket.yml file is only supported in the root of your repo and with no other file extensions than the .yml one.

Fields

All fields listed here are optional.

ignore

The ignore key is an array of strings that are used to ignore folders or files.

The individual strings in the ignore array work like .gitignore patterns.

The following patterns are always included in the ignore array by default:

  • node_modules
  • .yarn

enabled

Default: true.

If you want the Socket GitHub app to never run on a repo and do not have org permissions to disable GitHub access to that repo, you can add a socket.yml file to your repo and set enabled to false.

Setting enabled to false will override other settings in the socket.yml associated with the GitHub app.

pullRequestAlertsEnabled

Default: true.

The pullRequestAlertsEnabled field can be used to individually disable pull request alerts check runs and pull request comments generated by the Socket.dev GitHub app.

The enabled field must be set to true for this field to have any effect.

projectReportsEnabled

Default: true.

The projectReportsEnabled field can be used to individually disable project reports check runs for commits from being generated.

The enabled field must be set to true for this field to have any effect.

beta

Default: false.

To opt in to new features before we roll them out to everyone, set this field to true. Please note that beta features may be unstable!


What’s Next

Learn how to ignore specific pull request alerts in Socket for GitHub:

Did this page help you?