Skip to content

Commit

Permalink
chore: create README
Browse files Browse the repository at this point in the history
  • Loading branch information
CompeyDev authored Oct 17, 2022
1 parent aa443dc commit d3c3b89
Showing 1 changed file with 57 additions and 0 deletions.
57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@



<div align="center">
<h1>Rojo Build Action</h1>
This action swiftly builds your rojo places, models & assets.
<br>
<br>
<img src="https://media.discordapp.net/attachments/1016799328389574747/1031582625418190888/unknown.png"></img>
</div>



## Inputs

### `output`

**Required** This is the file you want the action to output the build at. Make sure this does not include any file extensions.

### `type`

**Required** The type of file to output (rbxm, rbxlx, etc.). Defaults to rbxlx.

## Example usage

```yml
on:
workflow_dispatch:
push: {branches: ["master", "main"]}

jobs:
status:
runs-on: ubuntu-latest
name: Build Rojo Project
steps:
- name: Checkout files
uses: actions/checkout@v3
- name: Build
uses: CompeyDev/rojo-build-action@0.1.0
with:
output: model
id: rbxm
- name: Commit and push if there are changes
run: |-
git diff
git config --global user.email "hi@devcomp.xyz"
git config --global user.name "BuildBot"
git diff --quiet || (git add -u && git commit -m "chore(deploy): build rojo project")
git push
```
---
### Discord Status: 🔴
---
This repository is licensed under a [MIT](https://compeydev.mit-license.org) License.

0 comments on commit d3c3b89

Please sign in to comment.