Skip to content

Feature: CI cache pip and platformio install; doc #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcuw merged 2 commits into from
Apr 19, 2026
Merged

Feature: CI cache pip and platformio install; doc #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66f0cb6
feature(ci): cache pip and platformio core install and always use lat…
mcuw Apr 19, 2026
51c96a6
doc: add description about .factory. firmwares
mcuw Apr 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,22 @@ jobs:
steps:
- name: Checkout repo
uses: actions/checkout@v6
# https://github.com/actions/cache
- uses: actions/cache@v5
with:
path: |
~/.cache/pip
~/.platformio/.cache
key: ${{ runner.os }}-pio
- name: Set up python
uses: actions/setup-python@v6
with:
architecture: "x64"
# https://docs.platformio.org/en/latest/core/history.html
- name: Install PlatformIO
run: python3 -m pip install platformio==6.1.19
- name: Install PlatformIO core
run: pip install --upgrade platformio
- name: Build firmwares
run: FIRMWARE_VERSION=main platformio run
run: FIRMWARE_VERSION=main pio run
- name: Archive
uses: actions/upload-artifact@v7
with:
Expand Down
13 changes: 10 additions & 3 deletions .github/workflows/build_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,22 @@ jobs:
steps:
- name: Checkout repo
uses: actions/checkout@v6
# https://github.com/actions/cache
- uses: actions/cache@v5
with:
path: |
~/.cache/pip
~/.platformio/.cache
key: ${{ runner.os }}-pio
- name: Set up python
uses: actions/setup-python@v6
with:
architecture: "x64"
# https://docs.platformio.org/en/latest/core/history.html
- name: Install PlatformIO
run: python3 -m pip install platformio==6.1.19
- name: Install PlatformIO core
run: pip install --upgrade platformio
- name: Build firmwares
run: FIRMWARE_VERSION=${{github.ref_name}} platformio run
run: FIRMWARE_VERSION=${{github.ref_name}} pio run
- name: Archive
uses: actions/upload-artifact@v7
with:
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,12 +84,12 @@ git push origin v1.0.0

(do not use `create release` on github)

6. You can find your firmwares under `Releases` after the CI build finished
6. After the CI build, you can find your firmware files under “Releases”. Files with `.factory.` in the name are meant for the initial flashing via cable. The others are for updates (e.g. OTA) when a factory version is already on the device. The `.factory.` files also include a pre-installed file system, bootloader, partition scheme, and safeboot partition.

## How to flash your microcontroller

Variant A - Online and no need to install an app
- download a `.bin` firmware file from releases then flash with:
- download a `.factory.bin` or `.bin` firmware file from releases then flash with:
https://mcuw.github.io/ESPConnect/

Variant B - Visual Studio Code
Expand Down
Loading