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

A ready-to-use CI/CD Pipeline for deploying your Rust applications to Shuttle.
https://github.com/fluent-ci-templates/shuttle-pipeline

cicd dagger deno pipeline rust rust-lang shuttle-rs typescrpit

Last synced: about 1 month ago
JSON representation

A ready-to-use CI/CD Pipeline for deploying your Rust applications to Shuttle.

• Host: GitHub
• URL: https://github.com/fluent-ci-templates/shuttle-pipeline
• Owner: fluent-ci-templates
• License: mit
• Created: 2023-07-31T12:37:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-06-18T15:48:55.000Z (6 months ago)
• Last Synced: 2024-07-24T01:02:31.696Z (5 months ago)
• Topics: cicd, dagger, deno, pipeline, rust, rust-lang, shuttle-rs, typescrpit
• Language: TypeScript
• Homepage:
• Size: 204 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

        
# Shuttle Pipeline

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

[![deno module](https://shield.deno.dev/x/shuttle_pipeline)](https://deno.land/x/shuttle_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/shuttle)](https://jsr.io/@fluentci/shuttle)

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

A ready-to-use CI/CD Pipeline for deploying your shuttle applications to [Shuttle](https://shuttle.rs/).

## 🚀 Usage

Run the following command:

```bash

fluentci run shuttle_pipeline

```

## 🧩 Dagger Module

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

```bash

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

```

Call `deploy` function from this module:

```bash

dagger call deploy --src . --api-key SHUTTLE_API_KEY

```

## 🛠️ Environment Variables

| Variable        | Description                      |

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

| SHUTTLE_API_KEY | Your Shuttle API key             |

| SHUTTLE_VERSION | The version of `cargo shuttle`, defaults to `v0.39.0` |

## ✨ Jobs

| Job     | Description                                 |

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

| deploy  | Deploy your shuttle application to shuttle.rs. |

```typescript

 deploy(

  src: string | Directory | undefined = ".",

  apiKey?: string | Secret,

  shuttleVersion?: string,

): Promise

```

## 👨‍💻 Programmatic usage

You can also use this pipeline programmatically:

```typescript

import { deploy } from "jsr:@fluentci/shuttle";

await deploy(".");

```