https://github.com/fluentci-io/ruff-plugin

Set up your CI/CD Pipeline with a specific version of Ruff
https://github.com/fluentci-io/ruff-plugin

continuous-delivery continuous-integration plugin ruff rust wasm webassembly

Last synced: 2 months ago
JSON representation

Set up your CI/CD Pipeline with a specific version of Ruff

• Host: GitHub
• URL: https://github.com/fluentci-io/ruff-plugin
• Owner: fluentci-io
• License: mit
• Created: 2024-04-22T15:25:38.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-07-25T17:58:07.000Z (6 months ago)
• Last Synced: 2024-07-25T20:56:03.619Z (6 months ago)
• Topics: continuous-delivery, continuous-integration, plugin, ruff, rust, wasm, webassembly
• Language: Rust
• Homepage:
• Size: 7.81 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ruff Plugin

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

[![ci](https://github.com/fluentci-io/ruff-plugin/actions/workflows/ci.yml/badge.svg)](https://github.com/fluentci-io/ruff-plugin/actions/workflows/ci.yml)

This plugin sets up your CI/CD pipeline with a specific version of [ruff](https://github.com/astral-sh/ruff).

## 🚀 Usage

Add the following command to your CI configuration file:

```bash

fluentci run --wasm ruff setup

```

## Functions

| Name   | Description                                |

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

| setup  | Installs a specific version of ruff.       |

| check  | Run Ruff on the given files or directories |

| clean  | Clear any caches in the current directory and any subdirectories |

| format | Run the Ruff formatter on the given files or directories |

## Code Usage

Add `fluentci-pdk` crate to your `Cargo.toml`:

```toml

[dependencies]

fluentci-pdk = "0.1.9"

```

Use the following code to call the plugin:

```rust

use fluentci_pdk::dag;

// ...

dag().call("https://pkg.fluentci.io/[email protected]?wasm=1", "setup", vec!["latest"])?;

```

## 📚 Examples

Github Actions:

```yaml

- name: Setup Fluent CI CLI

  uses: fluentci-io/setup-fluentci@v5

  with:

    wasm: true

    plugin: ruff

    args: |

      setup

- name: Show ruff version

  run: |

    type ruff

    ruff --version

```