Skip to content

Update secret push protection docs to visually explain workflow

Overview

As discussed over Slack (internal, only available for 90 days), we would like to update the secret push protection documentation to provide a visual explanation of the developer workflow when using the feature. The workflow should be explained in terms of:

  • Git operations and hooks supported
    • git commit
      • No secret detection scanning done at the moment.
    • git push
      • Secret push protection takes place in the pre-receive hook.
      • After a push is received, Pipeline SD kicks off.
  • Cost and risk scale (when detecting a secret in a local machine vs. remote repository).

It is also important to update the documentation to match whatever is described in the diagram created.

Resources

It would also be helpful to use the following resources as a guide:

Edited by Ahmed Hemdan