https://github.com/jurassiscripts/setup-velociraptor

A GitHub Action to setup Velociraptor
https://github.com/jurassiscripts/setup-velociraptor

github-actions velociraptor

Last synced: about 1 month ago
JSON representation

A GitHub Action to setup Velociraptor

• Host: GitHub
• URL: https://github.com/jurassiscripts/setup-velociraptor
• Owner: jurassiscripts
• License: mit
• Created: 2021-03-20T20:06:26.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-11-30T02:36:25.000Z (about 3 years ago)
• Last Synced: 2024-10-05T09:46:06.364Z (3 months ago)
• Topics: github-actions, velociraptor
• Homepage:
• Size: 36.1 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Setup velociraptor

[![CI](https://github.com/jurassiscripts/setup-velociraptor/actions/workflows/ci.yml/badge.svg)](https://github.com/jurassiscripts/setup-velociraptor/actions/workflows/ci.yml)

This action sets up [Velociraptor](https://github.com/jurassiscripts/velociraptor) environment for use in actions.

For convenience, `setup-velociraptor@v2` can also run automatically [`actions/checkout@v2`](https://github.com/marketplace/actions/checkout) and [`denoland/setup-deno@1`](https://github.com/marketplace/actions/setup-deno).

## Usage

See [action.yml](action.yml)

### @v2

Basic:

```yaml

steps:

  - uses: jurassiscripts/setup-velociraptor@v2

  - run: |

      vr --version

```

| Input                  | Description                          | Default value |

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

| `checkout`             | Whether to checkout repository first | `true`        |

| `deno-version`         | Deno version to use                  | `1.x`         |

| `velociraptor-version` | Velociraptor version to use          | `latest`      |

| `velociraptor-alias`   | Velociraptor alias name              | `vr`          |

| Output                 | Description                                          | 

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

| `deno-is-canary`       | Whether installed Deno version is a canary version   | 

| `deno-version`         | Deno version that was installed                      | 

| `velociraptor-version` | Velociraptor version that was installed              | 

### @v1

Basic:

```yaml

steps:

  - uses: actions/checkout@v2

  - uses: denoland/setup-deno@v1

  - uses: jurassiscripts/setup-velociraptor@v1

  - run: |

      vr --version

```

| Input                  | Description                 | Default value |

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

| `velociraptor-version` | Velociraptor version to use | `latest`      |

| `velociraptor-alias`   | Velociraptor alias name     | `vr`          |

## License

The scripts and documentation in this project are released under the

[MIT License](LICENSE)