https://github.com/dylibso/xtp-ci-demo

https://github.com/dylibso/xtp-ci-demo

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/dylibso/xtp-ci-demo
• Owner: dylibso
• Created: 2024-10-03T22:56:41.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-11-18T22:24:36.000Z (about 1 month ago)
• Last Synced: 2024-11-18T23:22:53.036Z (about 1 month ago)
• Language: Rust
• Size: 200 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# xtp-ci

A CI workflow using [XTP](https://www.getxtp.com/) and [Extism](https://github.com/extism/extism)

## Github

To use xtp-ci from Github actions, add the following to your workflow:

```

- uses: dylibso/xtp-ci-demo@main

  with:

    action: checkRepo

    token: ${{ secrets.XTP_TOKEN }}

    appId: ${{ secrets.XTP_APP_ID }}

    guestKey: myGuestKey

    binding: my-binding-name

```

## Gitlab

To use xtp-ci from Gitlab CI, add the following to your configuration file:

```

include:

  - component: $CI_SERVER_FQDN/zshipko/xtp-ci@main

    inputs:

      token: $XTP_TOKEN

      appId: $XTP_APP_ID

      guestKey: myGuestKey

      binding: my-binding-name

```

(in this example $XTP_TOKEN and $XTP_APP_ID are Gitlab CI variables)

## Local

Create a `.env` file with the following environment variables:

```

XTP_TOKEN=""

XTP_GUEST_KEY=""

XTP_APP_ID=""

XTP_BINDING_NAME=""

```

Then you can run:

```

node dist/index.js {scanFiles|checkRepo}

```

## Writing a plugin

There are two different operations that can be implemented in a plugin.

- `scanFiles` receives `RepoInfo` as input with `inputFile` populated, it will

  be called once for each file. Returning an error `CheckResult` (where `result.status = "error"`)

  will cause the action to fail.

- `checkRepo` receives `RepoInfo` as input with no `inputFile` and is called once

  for the entire repo. Like, `scanFiles` returning an error `CheckResult` will

  cause the action to fail.