Skip to main content

Playbooks

The playbooks enable you to customize and automate GitGuardian behavior. They are accessible in your workspace settings.

If you need other playbooks, do not hesitate to submit your request here.

Auto-healing playbook#

The auto-healing playbook automates the process of sharing the incident with the developer involved.

Whenever a new incident is detected, GitGuardian automatically turns on the sharing option of the incident and sends an email with the unique link to the developer involved, unless the developer is already a member of the workspace.

You can then choose which options would be automatically applied to the share link:

Auto healing playbook

The email sent automatically by GitGuardian is not customizable yet.

The emails are sent only to addresses considered as well formed and not matched by one of the exclude patterns aiming at detecting bots.

The auto-healing playbook is created by default by GitGuardian and is only accessible for workspaces under Business plan or in business trial. Only Owner and Managers of the workspace can activate or deactivate the playbook.

Auto-access granting playbook#

The auto-access granting playbook automates the process of giving access to an incident's details in the GitGuardian dashboard, for members with a Restricted role.

Not only does this apply for real-time detection whenever a new incident is raised, it also applies to all historical incidents the developer was involved in. GitGuardian will automatically give the Restricted user access to the incident details page in the dashboard, this is done by matching the commit author email against the dashboard user email. Here is a description of the flow:

Auto healing playbook

GitGuardian does not send sign-up invitations to the commit authors, they need to be already Restricted members of the workspace.