platformio.yml

# yaml-language-server: $schema=https://github.com/SchemaStore/schemastore/raw/master/src/schemas/json/github-workflow.json

# PlatformIO Build Workflow
#   https://docs.platformio.org/en/latest/integration/ci/github-actions.html

# Only tests for the standard enviroment defined in the platformio.ini!

# TODO Get Version Name in here! (hint: see scripts/ci)

name: PlatformIO
# run-name: Deploy to ${{ inputs.deploy_target }} by @${{ github.actor }}

on:
  push:
    branches: [ "main" ] # Only run on main branch
    paths:               # Only run on these directories
      - data
      - inc
      - include
      - src
  pull_request:
    branches: [ "main" ] # Only run on main branch
    paths:               # Only run on these directories
      - data
      - inc
      - include
      - src
  # Allows to run this workflow manually from the Actions tab
  workflow_dispatch:

permissions:
  contents: write

# TODO Set enviroment variable for later use
# env:
#   BUILD: GITHUB

jobs:
  build:
    name: PlatformIO Build
    runs-on: ${{ matrix.os }}
    timeout-minutes: 120
    strategy:
      matrix:
        os: [windows-latest, ubuntu-latest, macos-latest]
        include:
          - os: windows-latest
            path:
              ~\AppData\Local\pip\Cache
              ~\.platformio\.cache
          - os: ubuntu-latest
            path:
              ~/.cache/pip
              ~/.platformio/.cache
          - os: macos-latest
            path:
              ~/Library/Caches/pip
              ~/.platformio/.cache

    permissions:
      actions: read          # private repos
      contents: write        # private repos
      packages: read         # fetch internal or private CodeQL packs
      security-events: write # all workflows

    steps:
    - name: Checkout Repo
      uses: actions/checkout@v4
    - name: Setup Cache
      uses: actions/cache@v4
      with:
        key:
          ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
          ${{ runner.os }}-pio
        path: ${{ matrix.path }}
        restore-keys:
          ${{ runner.os }}-pip-
          ${{ runner.os }}-pio
    - name: Setup Python
      uses: actions/setup-python@v5
      with:
        python-version: 3.x
        check-latest: true # is cached version latest?
        cache: pip         # caching pip dependencies
    - name: 'PlatformIO: Install Core'
      run: |
        python -m pip install --upgrade pip
        pip install --upgrade platformio
    - name: 'PlatformIO: Show Project Config'
      run: pio project config
    - name: 'PlatformIO: Build Project'
      run: pio run