Skip to content
download

GitHub Action

Setup BlitzMax NG

v1 Latest version

Setup BlitzMax NG

download

Setup BlitzMax NG

Setup a specific BlitzMax NG version for later use

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Setup BlitzMax NG

              
  uses: Hezkore/setup-blitzmax-action@v1
Learn more about this action in Hezkore/setup-blitzmax-action

Choose a version

logo

Setup BlitzMax NG Action

GitHub Action that allows you to setup a specific BlitzMax NG version 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
  • 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.

Usage

Make sure you read the BlitzMax NG bmk docs:
blitzmax.org/docs/en/tools/bmk

Example workflow:

# 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

# 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