Python package #46
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: PlatformIO CI | |
| # Controls when the action will run. | |
| on: [push, pull_request, workflow_dispatch] | |
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | |
| jobs: | |
| # The introduction just shows some useful informations. | |
| intro: | |
| # The type of runner that the job will run on. | |
| runs-on: ubuntu-latest | |
| # Steps represent a sequence of tasks that will be executed as part of the job. | |
| steps: | |
| - run: echo "The job was automatically triggered by a ${{ github.event_name }} event." | |
| - run: echo "The name of the branch is ${{ github.ref }} and the repository is ${{ github.repository }}." | |
| # Perform static checks | |
| check: | |
| # The type of runner that the job will run on | |
| runs-on: ubuntu-latest | |
| needs: intro | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Cache pip | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Cache PlatformIO | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.platformio | |
| key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }} | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.9' | |
| - name: Install PlatformIO | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install --upgrade platformio | |
| - name: Perform static checks on native environment | |
| run: platformio check --environment native --fail-on-defect=medium --fail-on-defect=high | |
| # Perform tests | |
| test: | |
| # The type of runner that the job will run on. | |
| runs-on: ubuntu-latest | |
| needs: intro | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Cache pip | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Cache PlatformIO | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.platformio | |
| key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }} | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.9' | |
| - name: Install PlatformIO | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install --upgrade platformio | |
| - name: Run tests on native environment | |
| run: platformio test --environment native -vvv | |
| # Build documentation | |
| doc: | |
| # The type of runner that the job will run on. | |
| runs-on: ubuntu-latest | |
| needs: intro | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Set up graphviz | |
| uses: ts-graphviz/[email protected] | |
| - name: Set up doxygen and generate documentation for SerialMuxProt | |
| uses: mattnotmitt/[email protected] | |
| with: | |
| working-directory: './doc/doxygen' | |
| doxyfile-path: './Doxyfile' | |
| - name: Print doxygen warnings | |
| if: ${{ failure() }} | |
| run: cat ./doc/doxygen/doxygen_warnings.txt | |
| # Build examples | |
| build: | |
| # The type of runner that the job will run on. | |
| runs-on: ubuntu-latest | |
| needs: intro | |
| # Steps represent a sequence of tasks that will be executed as part of the job | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v3 | |
| - name: Cache pip | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.cache/pip | |
| key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }} | |
| restore-keys: | | |
| ${{ runner.os }}-pip- | |
| - name: Cache PlatformIO | |
| uses: actions/cache@v3 | |
| with: | |
| path: ~/.platformio | |
| key: ${{ runner.os }}-${{ hashFiles('**/lockfiles') }} | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: '3.9' | |
| - name: Install PlatformIO | |
| run: | | |
| python -m pip install --upgrade pip | |
| pip install --upgrade platformio | |
| - name: Build example for ServerA | |
| run: platformio ci examples/ServerA/* --lib . --lib examples/SerialMuxChannels.h -c platformio.ini -e esp32dev | |
| - name: Build example for ServerB | |
| run: platformio ci examples/ServerB/* --lib . --lib examples/SerialMuxChannels.h -c platformio.ini -e esp32dev |