Skip to content

Commit

Permalink
Merge commit '597359409681b335b28a9098612e0c80d76c51da'
Browse files Browse the repository at this point in the history
  • Loading branch information
drkameleon committed May 22, 2024
2 parents f00f60c + 5973594 commit db8f35d
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@

<h1>Arturo Bundler</h1>

### Easily bundle an Arturo app on any GitHub runner/OS<br><br>![License](https://img.shields.io/github/license/arturo-lang/bundler?style=for-the-badge) [![Build Status](https://img.shields.io/github/actions/workflow/status/arturo-lang/bundler/test.yml?branch=main&style=for-the-badge)](https://github.com/arturo-lang/bundler/actions)
### Easily bundle an Arturo app on any GitHub runner/OS<br><br>![License](https://img.shields.io/github/license/arturo-lang/bundler?style=for-the-badge) [![Build Status](https://img.shields.io/github/actions/workflow/status/arturo-lang/bundler/testbundle.yml?branch=main&style=for-the-badge)](https://github.com/arturo-lang/bundler/actions)
</div>

---

<!--ts-->
* [How do I use it?](#how-do-i-use-it)
* [More options](#more-options)
* [How can I release an app?](#how-can-i-release-an-app)
* [License](#license)
<!--te-->

Expand Down Expand Up @@ -43,7 +44,33 @@ Based on the runner, the action will compile and setup the appropriate, native b
| option | description |
|--------|-------------|
| target | change the name of the final binary (default: `'auto'` = use the same name as the entry script) |
| version | set version number, to be included in the archive names (default: `''`) |
| version | set version number, to be included in the archive names - in the case of releases, this will be extracted automatically from the release tag (default: `''`) |

### How can I release an app?

With Arturo's bundler and the appropriate setup, you can instantly offer binaries for all major OSes, as part of your GitHub repo's workflows.

But, panic not! We've got you covered! 😉

Actually it's very streamlined and easy:

- create a `.github/` folder inside your repo
- create a `workflows/` folder inside the above folder (in case it's not already there, obviously)
- create a new file in `./github/workflows/` (name it `asyouwish.yml`)
- copy the contents of [https://github.com/arturo-lang/bundler/blob/main/.github/workflows/testrelease.yml](https://github.com/arturo-lang/bundler/blob/main/.github/workflows/testrelease.yml)
- change only the relevant part above for your own app

> [!NOTE]
> The configuration you have to complete mainly includes 3 fields:
> - `app-name:` The name of your binary as it will appear
> - `app-entry:` The "entry point" of your app (see [above^](#how-do-i-use-it))
> - `app-notes:` (Optionally) add some description that will appear at the bottom of the release

And done! 💥

Next time you push a new `vX.Y.Z` tag, a new release will be automatically created, along with all the binaries of your app for Linux/macOS/Windows (and more coming?).

Sounds amazing? It actually *is*! 🚀

------

Expand Down

0 comments on commit db8f35d

Please sign in to comment.