Skip to content

Commit 3ef7156

Browse files
committed
Prepare v1 release
1 parent 4346134 commit 3ef7156

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

+7-3
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,17 @@ jobs:
1818
with:
1919
submodules: 'recursive'
2020
- name: esp-idf build
21-
uses: espressif/esp-idf-ci-action@main
21+
uses: espressif/esp-idf-ci-action@v1
2222
with:
2323
esp_idf_version: v4.4
2424
target: esp32s2
2525
path: 'esp32-s2-hmi-devkit-1/examples/smart-panel'
2626
```
2727

28+
## Version
29+
30+
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.
31+
2832
## Parameters
2933

3034
### `path`
@@ -54,5 +58,5 @@ Default: `idf.py build`
5458
Overriding this is useful for running other commands via github actions. Example:
5559

5660
```yaml
57-
command: esptool.py merge_bin -o ../your_final_output.bin @flash_args
58-
```
61+
command: esptool.py merge_bin -o ../your_final_output.bin @flash_args
62+
```

0 commit comments

Comments
 (0)