install-micropython

This action provides the following functionality for GitHub Actions users:

• Builds and installs the following executables:
  • micropython - The micropython runtime. Can be used to run unit tests in conjunction with libraries such as micropython's unittest.
  • mpy-cross - The micropython cross-compiler. Used to cross-compile precompiled bytecode for specific microcontroller architectures.
• Provides a clone of the micropython repository and sets the environment variable MPY_DIR to it's path.
  • Can be used as for artifact building, like using native machine code in mpy files.
• Builds are automatically cached, speeding up subsequent runs.

Basic Usage

Simply add the following step to your workflow:

steps:
  - name: Install MicroPython
    uses: BrianPugh/install-micropython@v2

Configuration

The install-micropython action can be configured by setting values under the with: key. For example:

steps:
  - uses: BrianPugh/install-micropython@v2
    with:
      reference: v1.20.0

Input configuration arguments are described as follows.

repository

The micropython git url to clone from. Defaults to the official micropython repository.

with:
  repository: https://github.com/micropython/micropython

reference

A git reference (tag, commit, or branch) of the micropython repository to use.

with:
  reference: v1.20.0

cflags

When compiling micropython binaries, this value gets passed along to environment variable CFLAGS_EXTRA. This can be used to enable/disable certain micropython features.

with:
  cflags: '-DMICROPY_PY_RE_MATCH_GROUPS=1'