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

A ready-to-use CI/CD Pipeline for analyzing your code with SonarCloud.
https://github.com/fluent-ci-templates/sonar-pipeline

cicd deno pipeline sonarcloud typescript

Last synced: about 5 hours ago
JSON representation

A ready-to-use CI/CD Pipeline for analyzing your code with SonarCloud.

• Host: GitHub
• URL: https://github.com/fluent-ci-templates/sonar-pipeline
• Owner: fluent-ci-templates
• License: mit
• Created: 2023-08-12T11:33:31.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-18T20:52:05.000Z (5 months ago)
• Last Synced: 2024-07-24T01:02:17.456Z (4 months ago)
• Topics: cicd, deno, pipeline, sonarcloud, typescript
• Language: TypeScript
• Homepage:
• Size: 197 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

        
# Sonar Pipeline

[![fluentci pipeline](https://shield.fluentci.io/x/sonar_pipeline)](https://pkg.fluentci.io/sonar_pipeline)

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

[![dagger-min-version](https://shield.fluentci.io/dagger/v0.11.7)](https://dagger.io)

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

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

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

A ready-to-use CI/CD Pipeline for analyzing your code with [SonarCloud](https://sonarcloud.io/).

## 🚀 Usage

Run the following command in your project:

```bash

fluentci run sonar_pipeline

```

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

```bash

fluentci init -t sonar

```

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/sonar-pipeline@main

```

## 🛠️ Environment variables

| Variable           | Description                                           | Required |

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

| SONAR_TOKEN        | SonarCloud token                                      | yes     |

| SONAR_ORGANIZATION | SonarCloud organization                               | yes     |

| SONAR_PROJECT_KEY  | SonarCloud project key                                | yes     |

| SONAR_HOST_URL     | SonarCloud host URL. Default: `https://sonarcloud.io` | no    |

| SONAR_SOURCES      | SonarCloud sources. Default: `.`                      | no    |

## ✨ Jobs

| Job       | Description                              |

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

| analyze   | Run SonarScanner and push to SonarCloud. |

```typescript

analyze(

  src: string | Directory,

  token: string | Secret,

  organization?: string,

  projectKey?: string,

  sources?: string

): Promise

```

## 👨‍💻 Programmatic usage

You can also use this pipeline programmatically:

```ts

import { analyze } from "jsr:@fluentci/sonar";

await analyze();

```