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

A ready-to-use CI/CD Pipeline for Zig projects.
https://github.com/fluent-ci-templates/zig-pipeline

cicd dagger deno deno-module devops pipeline typescript zig

Last synced: about 1 month ago
JSON representation

A ready-to-use CI/CD Pipeline for Zig projects.

• Host: GitHub
• URL: https://github.com/fluent-ci-templates/zig-pipeline
• Owner: fluent-ci-templates
• License: mit
• Created: 2023-07-04T17:09:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-18T20:06:29.000Z (6 months ago)
• Last Synced: 2024-07-24T01:02:24.378Z (5 months ago)
• Topics: cicd, dagger, deno, deno-module, devops, pipeline, typescript, zig
• Language: TypeScript
• Homepage:
• Size: 154 KB
• Stars: 1
• 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

        
# Zig Pipeline

[![fluentci pipeline](https://shield.fluentci.io/x/zig_pipeline)](https://pkg.fluentci.io/zig_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/zig)](https://jsr.io/@fluentci/zig)

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

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

A ready-to-use CI/CD Pipeline for your [Zig](https://ziglang.org/) projects.

## 🚀 Usage

Run the following command in your project:

```bash

fluentci run zig_pipeline

```

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

```bash

fluentci init -t zig

```

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

```

Call a function from the module:

```bash

dagger -m github.com/fluent-ci-templates/zig-pipeline call \

  test --src .

dagger -m github.com/fluent-ci-templates/zig-pipeline call \

  build --src .

```

## 🛠️ Environment variables

| Variable        | Description                                    |

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

| `ZIG_VERSION`   | The version of Zig to use. Defaults to `0.10.1` |

## ✨ Jobs

| Job       | Description   |

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

| test      | Run tests     |

| build     | Build project |

```typescript

test(

  src: Directory | string = ".",

  version?: string

): Promise

build(

  src: Directory | string = ".",

  version?: string

): Promise

```

## 👨‍💻 Programmatic usage

You can also use this pipeline programmatically:

```ts

import { test, build } from "jsr:@fluentci/zig";

await test();

await build();

```