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

A ready-to-use CI/CD Pipeline and jobs for Gleam projects.
https://github.com/fluent-ci-templates/gleam-pipeline

cicd deno deno-module devops gleam pipeline typescript

Last synced: about 1 month ago
JSON representation

A ready-to-use CI/CD Pipeline and jobs for Gleam projects.

• Host: GitHub
• URL: https://github.com/fluent-ci-templates/gleam-pipeline
• Owner: fluent-ci-templates
• License: mit
• Created: 2023-07-04T17:10:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-22T20:00:37.000Z (4 months ago)
• Last Synced: 2024-08-22T21:56:41.139Z (4 months ago)
• Topics: cicd, deno, deno-module, devops, gleam, pipeline, typescript
• Language: TypeScript
• Homepage:
• Size: 282 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

        
# Gleam Pipeline

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

[![deno module](https://shield.deno.dev/x/gleam_pipeline)](https://deno.land/x/gleam_pipeline)

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

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

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

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

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

A ready-to-use CI/CD Pipeline for your [Gleam](https://gleam.run) projects.

## 🚀 Usage

Run the following command:

```bash

fluentci run gleam_pipeline

```

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

```bash

fluentci init -t gleam

```

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

Now you can run the pipeline with:

```bash

dagger run fluentci .

```

Or simply:

```bash

fluentci

```

## 🧩 Dagger Module

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

```bash

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

```

Call a function from the module:

```bash

dagger -m github.com/fluent-ci-templates/gleam-pipeline@main call \

  check --src .

dagger -m github.com/fluent-ci-templates/gleam-pipeline@main call \

  format --src .

dagger -m github.com/fluent-ci-templates/gleam-pipeline@main call \

  test --src .

dagger -m github.com/fluent-ci-templates/gleam-pipeline@main call \

  build --src .

```

## ✨ Jobs

| Job    | Description         |

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

| check  | Run type checking   |

| format | Format source code  |

| test   | Run the tests       |

| build  | Build the project   |

```typescript

check(

  src: Directory | string | undefined = "."

): Promise

format(

  src: Directory | string | undefined = "."

): Promise

test(

  src: Directory | string | undefined = "."

): Promise

build(

  src: Directory | string | undefined = "."

): Promise

```

## 👨‍💻 Programmatic usage

You can also use this pipeline programmatically:

```ts

import { check, format, test, build } from "jsr:@fluentci/gleam";

await check();

await format();

await test();

await build();

```