Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

Override default gitleaks configuration #2

Closed
wants to merge 1 commit into from

Conversation

ivankalitaonefootball
Copy link

@ivankalitaonefootball ivankalitaonefootball commented Sep 2, 2021

Override default gitleaks configuration

We use default gitleaks rules. These rules sometimes have some flaws, e.g. we have a lot of false positives for the Twitter Client IDs because of the default Twitter rules (more information). To fix this problem I override the default gitleaks rules with the rules provided by this repository (/gitleaks.toml).

Also, I set a reasonable default (.of/security/gitleaks.toml) for the config-path input argument and fix its description to reflect the fact that it's not the main configuration file but an additional config.

Questions

  • How does the release process for this action work? If I understand correctly we'll need to either override the tag v1.6.0-of-custom or update all the repositories to use the new version of motain/gitleaks-action
  • Is it ok that one of the gitleaks actions fails? I mean should I fix it? If I do this the fork will diverge too much from the upstream.
  • I'm not sure how much OF semantics/processes I can share in this repository because it's public.

I override the default gitleaks configuration by a configuration provided by
this repository so we can have more control over the default gitleaks rules
applied to all the motain repositories.

Set the valid default to config-path. Config path input of github action is
actually the path to additional gitleaks configuration. I set it to
.of/security/gitleaks.toml by default and changed the description.
@ivankalitaonefootball ivankalitaonefootball requested a review from a team September 3, 2021 06:43
@ivankalitaonefootball ivankalitaonefootball marked this pull request as ready for review September 3, 2021 06:43
@@ -1,106 +0,0 @@
title = "gitleaks config"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file was not used at all 🤷

required: false
default: '.github/.gitleaks.toml'

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This path does not exist on our repositories, instead, we use .of/security/gitleaks.toml, so I changed it.

@@ -0,0 +1,174 @@
title = "gitleaks config"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@andreabenfatto
Copy link

Closing because there was some misinterpretation of how we wanted to use Gitleaks,

@andreabenfatto andreabenfatto deleted the fix-default-gitleaks-config branch February 9, 2022 12:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants