Giter Site home page Giter Site logo

fluent-ci-templates / buf-pipeline Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 160 KB

A ready-to-use CI/CD Pipeline for linting and pushing Protobuf files to the Buf Registry.

License: MIT License

TypeScript 98.61% Nix 0.22% Go 0.71% Rust 0.46%
cicd deno pipeline protobuf typescript dagger fluentci wasm

buf-pipeline's Introduction

Buf Pipeline

fluentci pipeline deno compatibility dagger-min-version ci

A ready-to-use CI/CD Pipeline for linting and pushing Protobuf files to the Buf Registry.

๐Ÿš€ Usage

Run the following command in your project:

fluentci run buf_pipeline

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

fluentci init -t buf

This will create a .fluentci folder in your project.

Now you can run the pipeline with:

fluentci run .

๐Ÿงฉ Dagger Module

Use as a Dagger Module:

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

Call a function from this module:

dagger call format --src .
dagger call lint --src .
dagger call push --src . --token env:BUF_TOKEN

๐Ÿ› ๏ธ Environment variables

Variable Description
BUF_TOKEN The Buf Registry token.

โœจ Jobs

Job Description
lint Lint your Protobuf files with buf.
format Format your Protobuf files with buf.
push Push your Protobuf files to the Buf Registry.
  push(
    src: Directory | string,
    token: Secret | string
  ): Promise<string>

  format(
    src: Directory | string
  ): Promise<Directory | string>

  lint(src: Directory | string): Promise<string>

๐Ÿ‘จโ€๐Ÿ’ป Programmatic usage

You can also use this pipeline programmatically:

import { lint, push } from "jsr:@fluentci/buf";

await lint(".");
await push(".", Deno.env.get("BUF_TOKEN")!);

buf-pipeline's People

Contributors

tsirysndr avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.