Commit 8b554a13 authored by Clement Bois's avatar Clement Bois
Browse files

Merge branch 'feat/tbc-default-for-global-dependencies' into 'main' 

feat: TBC_DEFAULT for global dependencies

See merge request to-be-continuous/gitleaks!68
parents 3de33c66 b0e6f91d

README.md

+1 −1
Original line number Diff line number Diff line
@@ -78,7 +78,7 @@ They use the following configuration. 


| Input / Variable | Description                            | Default value     |

| --------------------- | -------------------------------------- | ----------------- |

| `image` / `GITLEAKS_IMAGE` | The Docker image used to run Gitleaks / betterleaks  | `docker.io/zricethezav/gitleaks:latest` <br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-GITLEAKS_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-GITLEAKS_IMAGE) |

| `image` / `GITLEAKS_IMAGE` | The Docker image used to run Gitleaks / betterleaks  | `docker.io/zricethezav/gitleaks:latest` (from `$TBC_DEFAULT_GITLEAKS_IMAGE`)<br/>[![Trivy Badge](https://to-be-continuous.gitlab.io/doc/secu/trivy-badge-GITLEAKS_IMAGE.svg)](https://to-be-continuous.gitlab.io/doc/secu/trivy-GITLEAKS_IMAGE) |

| `rules` / `GITLEAKS_RULES` | Gitleaks [configuration rules](https://github.com/zricethezav/gitleaks#configuration) to use (you may also provide your own `.gitleaks.toml` configuration file in your project). | _none_ (uses default rules) |

| `args` / `GITLEAKS_ARGS` | [Options](https://github.com/zricethezav/gitleaks/wiki/Options) for a full Gitleaks analysis (on master or develop branches) | `--verbose --redact` |

kicker.json

+2 −1
Original line number Diff line number Diff line
@@ -9,7 +9,8 @@ 
    {

      "name": "GITLEAKS_IMAGE",

      "description": "The Docker image used to run Gitleaks / betterleaks (official image: `ghcr.io/betterleaks/betterleaks:latest`)",

      "default": "docker.io/zricethezav/gitleaks:latest"

      "default": "docker.io/zricethezav/gitleaks:latest",

      "has_default": true

    },

    {

      "name": "GITLEAKS_RULES",

templates/gitlab-ci-gitleaks.yml

+4 −1
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ spec: 
  inputs:

    image:

      description: The Docker image used to run Gitleaks

      default: docker.io/zricethezav/gitleaks:latest

      default: $TBC_DEFAULT_GITLEAKS_IMAGE

    rules:

      description: Gitleaks [configuration rules](https://github.com/zricethezav/gitleaks/wiki/Configuration) to use (you may also provide your own `.gitleaks.toml` configuration file in your project).

      default: ''
@@ -89,6 +89,9 @@ workflow: 
    - when: on_success



variables:

  # Global defaults can be changed as instance or group variable

  TBC_DEFAULT_GITLEAKS_IMAGE: docker.io/zricethezav/gitleaks:latest



  # Default Docker image (can be overridden)

  GITLEAKS_IMAGE: $[[ inputs.image ]]

  GITLEAKS_ARGS: $[[ inputs.args ]]