README.md

Setup PlatformIO

This actions sets up PlatformIO for use in actions.

Usage

Use newest PlatformIO version

- name: Setup PlatformIO
  uses: n-vr/setup-platformio-action@v1

Specify the version of PlatformIO you want to use

- name: Setup PlatformIO
  uses: n-vr/setup-platformio-action@v1
  with:
    platformio-version: "5.2"

See inputs for more info.

Example workflow file

To use this example, create a .github/workflows/build-platformio.yml file in your repository and paste the contents below in it.

name: Build PlatformIO project
on:
  # Triggers the workflow on push or pull request events but only for the main branch
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      # Checkout repository
      - name: Checkout code
        uses: actions/checkout@v2
      
      # Setup PlatformIO in PATH
      - name: Setup PlatformIO
        uses: n-vr/setup-platformio-action@v1
      
      # Build the PlatformIO project
      - name: Build PlatformIO project
        run: pio run

Inputs

Use the with keyword to specify these inputs

platformio-version (optional)

Specify the PlatformIO to set up. Use semantic versioning (e.g. "5.2.5", "5.2" or "5"). If no version is specified, the newest version is used.

License

Distributed under the MIT license. See LICENSE.md for more information.

Acknowledgements

• PlatformIO