Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/espressif/esp-idf-ci-action
GitHub Action for ESP32 CI
https://github.com/espressif/esp-idf-ci-action
Last synced: 2 days ago
JSON representation
GitHub Action for ESP32 CI
- Host: GitHub
- URL: https://github.com/espressif/esp-idf-ci-action
- Owner: espressif
- License: mit
- Fork: true (georgik/esp-idf-ci-action)
- Created: 2021-06-25T11:00:26.000Z (over 3 years ago)
- Default Branch: v1
- Last Pushed: 2024-04-28T21:51:39.000Z (5 months ago)
- Last Synced: 2024-09-21T03:26:12.416Z (6 days ago)
- Size: 38.1 KB
- Stars: 66
- Watchers: 4
- Forks: 24
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp-idf-ci-action
GitHub Action for ESP32 CI
## Usage
Workflow definition
```
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v2
with:
submodules: 'recursive'
- name: esp-idf build
uses: espressif/esp-idf-ci-action@v1
with:
esp_idf_version: v4.4
target: esp32s2
path: 'esp32-s2-hmi-devkit-1/examples/smart-panel'
```
## Version
We recommend referencing this action as `espressif/esp-idf-ci-action@v1` and using `v1` instead of `main` to avoid breaking your workflows. `v1` tag always points to the latest compatible release.
## Parameters
### `path`
Path to the project to be built relative to the root of your repository.
### `esp_idf_version`
The version of ESP-IDF for the action. Default value `latest`.
It must be one of the tags from Docker Hub: https://hub.docker.com/r/espressif/idf/tags
More information about supported versions of ESP-IDF: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/versions.html#support-periods
### `target`
Type of ESP32 to build for. Default value `esp32`.
The value must be one of the supported ESP-IDF targets as documented here: https://github.com/espressif/esp-idf#esp-idf-release-and-soc-compatibility
### `command`
Optional: Specify the command that will run as part of this GitHub build step.
Default: `idf.py build`
Overriding this is useful for running other commands via github actions. Example:
```yaml
command: esptool.py merge_bin -o ../your_final_output.bin @flash_args
```