Skip to content
package

GitHub Action

Install MicroPython

v2.1.0 Latest version

Install MicroPython

package

Install MicroPython

Build and install MicroPython

Installation

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

              

- name: Install MicroPython

uses: BrianPugh/install-micropython@v2.1.0

Learn more about this action in BrianPugh/install-micropython

Choose a version

install-micropython

Basic validation

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.
  • 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@v1

Configuration

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

steps:
  - uses: BrianPugh/install-micropython@v1
    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