https://github.com/fluent-ci-templates/gitleaks-pipeline

A ready-to-use CI/CD Pipeline for detecting secrets in your code using Gitleaks
https://github.com/fluent-ci-templates/gitleaks-pipeline

Last synced: about 5 hours ago
JSON representation

A ready-to-use CI/CD Pipeline for detecting secrets in your code using Gitleaks

• Host: GitHub
• URL: https://github.com/fluent-ci-templates/gitleaks-pipeline
• Owner: fluent-ci-templates
• License: mit
• Created: 2023-11-22T18:55:33.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-04-19T07:38:46.000Z (7 months ago)
• Last Synced: 2024-07-24T01:02:39.069Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 150 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Gitleaks Pipeline

[![fluentci pipeline](https://img.shields.io/badge/dynamic/json?label=pkg.fluentci.io&labelColor=%23000&color=%23460cf1&url=https%3A%2F%2Fapi.fluentci.io%2Fv1%2Fpipeline%2Fgitleaks_pipeline&query=%24.version)](https://pkg.fluentci.io/gitleaks_pipeline)

![deno compatibility](https://shield.deno.dev/deno/^1.41)

[![dagger-min-version](https://img.shields.io/badge/dagger-v0.10.0-blue?color=3D66FF&labelColor=000000)](https://dagger.io)

[![](https://jsr.io/badges/@fluentci/gitleaks)](https://jsr.io/@fluentci/gitleaks)

[![](https://img.shields.io/codecov/c/gh/fluent-ci-templates/gitleaks-pipeline)](https://codecov.io/gh/fluent-ci-templates/gitleaks-pipeline)

[![ci](https://github.com/fluent-ci-templates/gitleaks-pipeline/actions/workflows/ci.yml/badge.svg)](https://github.com/fluent-ci-templates/gitleaks-pipeline/actions/workflows/ci.yml)

A ready-to-use CI/CD Pipeline for detecting secrets in your code using [Gitleaks](https://gitleaks.io/).

## 🚀 Usage

Run the following command:

```bash

fluentci run gitleaks_pipeline

```

Or, if you want to use it as a template:

```bash

fluentci init -t gitleaks

```

This will create a `.fluentci` folder in your project.

Now you can run the pipeline with:

```bash

fluentci run .

```

## 🧩 Dagger Module

Use as a [Dagger](https://dagger.io) module:

```bash

dagger install github.com/fluent-ci-templates/gitleaks-pipeline@main

```

Call a function from the module:

```bash

dagger call detect --src .

```

## ✨ Jobs

| Job     | Description                 |

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

| detect  | Detect secrets in your code |

```typescript

detect(

  src: string | Directory | undefined = "."

): Promise

```

## 👨‍💻 Programmatic usage

You can also use this pipeline programmatically:

```ts

import { detect } from "jsr:@fluentci/gitleaks";

await detect();

```