https://github.com/hezkore/setup-blitzmax-action

GitHub Action that allows you to setup a specific BlitzMax NG version for later use
https://github.com/hezkore/setup-blitzmax-action

action blitzmax workflow

Last synced: about 2 months ago
JSON representation

GitHub Action that allows you to setup a specific BlitzMax NG version for later use

• Host: GitHub
• URL: https://github.com/hezkore/setup-blitzmax-action
• Owner: Hezkore
• Created: 2021-04-28T07:49:52.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-04-29T17:16:48.000Z (over 3 years ago)
• Last Synced: 2024-10-14T01:47:39.315Z (3 months ago)
• Topics: action, blitzmax, workflow
• Language: JavaScript
• Homepage:
• Size: 9.26 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![logo](https://github.com/Hezkore/setup-blitzmax-action/blob/master/icons/extension-icon.png?raw=true)](https://blitzmax.org/)

# Setup BlitzMax NG Action

[GitHub Action](https://github.com/features/actions) that allows you to setup a specific [BlitzMax NG](https://blitzmax.org/) [version](https://github.com/bmx-ng/bmx-ng/tags) for later use.

## How does this work?

This action will run a job JavaScript that performs the following steps:

  * Fetch release info from [bmx-ng/releases](https://github.com/bmx-ng/bmx-ng/releases)

  * Figure out BlitzMax NG release equivalent platform name

  * Find and download matching release for the specified BlitzMax NG version and platform

  * Detect release archive type and use the correct tool to decompress

  * If needed; build BlitzMax NG on platforms that provide a **'run_me_first.command'** file

  * Cache the BlitzMax NG root folder for future jobs

  * Add BlitzMax NG **'bin'** folder to **PATH**

  * Add **'BMX_BIN'** env variable

  * Set action output **'bmx-root'**\

    _(for easy access if modules need to be added)_

You can then use the BlitzMax NG compiler via the normal bmk commands.\

[Read more about bmk.](https://blitzmax.org/docs/en/tools/bmk/)

## Usage

Make sure you read the BlitzMax NG bmk docs:\

[blitzmax.org/docs/en/tools/bmk](https://blitzmax.org/docs/en/tools/bmk/)\

\

Example workflow:

```yml

# file: .github/workflows/blitzmax-pipeline.yml

name: blitzmax-pipeline

on:

  # manual trigger

  workflow_dispatch:

jobs:

  my-linux-job:

    name: Setup BlitzMax NG for Linux

    runs-on: ubuntu-latest

    steps:

    - name: Checkout repository

      uses: actions/checkout@v2

    - name: Setup latest BlitzMax NG version

      uses: hezkore/setup-blitzmax-action@v1

      with:

        bmx-version: latest

        # latest (default)

        # or version (e.g. 0.128.3.45)

    - name: Build repository app

      run: bmk makeapp -r main.bmx

```

## Inputs

* `bmx-version`: BlitzMax NG version.\

  Can be either version _(e.g. `0.128.3.45`)_ or `latest` _(default)_.

## Output

* `bmx-root`: BlitzMax NG root directory.\

  Useful if modules needs to be added.

## More examples

```yml

# file: .github/workflows/blitzmax-pipeline.yml

name: blitzmax-pipeline

on:

  # manual trigger

  workflow_dispatch:

    inputs:

      # option for BlitzMax NG version

      bmx-ver:

        description: BlitzMax Version

        default: latest

        required: false

jobs:

  # compile your code on Windows

  my-windows-job:

    name: Setup BlitzMax NG for Windows

    runs-on: windows-latest

    steps:

    - name: Checkout repository

      uses: actions/checkout@v2

    - name: Setup latest BlitzMax NG version

      uses: hezkore/setup-blitzmax-action@v1

      with:

        bmx-version: ${{ github.event.inputs.bmx-ver }}

    - name: Build repository app

      run: bmk makeapp -r main.bmx

  # compile your code on MacOS

  my-macos-job:

    name: Setup BlitzMax NG for MacOS

    runs-on: macos-latest

    steps:

    - name: Checkout repository

      uses: actions/checkout@v2

    - name: Setup latest BlitzMax NG version

      uses: hezkore/setup-blitzmax-action@v1

      with:

        bmx-version: ${{ github.event.inputs.bmx-ver }}

    - name: Build repository app

      run: bmk makeapp -r main.bmx

    # - name: Your custom step

    #  run: echo 'Hello World'

  # echo BlitzMax NG root dir on Linux

  my-linux-job:

    name: Setup BlitzMax NG for Linux

    runs-on: ubuntu-latest

    steps:

    - name: Checkout repository

      uses: actions/checkout@v2

    - name: Setup latest BlitzMax NG version

      uses: hezkore/setup-blitzmax-action@v1

      id: bmx # set step reference ID

      with:

        bmx-version: ${{ github.event.inputs.bmx-ver }}

    - name: Echo BlitzMax NG root example

      run: echo '${{ steps.bmx.outputs.bmx-root }}' # use step reference ID

```