josephabbey/ESP-IDF Web Release Bundle
Package an ESP-IDF build into release assets, a release-notes snippet, and a GitHub Pages web installer payload.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| release-tag | Release tag to package. | yes | — |
| project-path | Path to the ESP-IDF project in the caller repository. | no | . |
| build-directory | Build directory relative to project-path. | no | build |
| repository | Repository name in owner/name form, used for release links. | no | "" |
| pages-base-url | Public base URL for the installer page, for example https://owner.github.io/repo/. | no | "" |
| pages-input-dir | Existing Pages content to merge into the new output directory. | no | "" |
| pages-output-dir | Directory to write the merged Pages site to. | no | dist/pages |
| release-assets-dir | Directory to write standalone release assets to. | no | dist/release-assets |
| release-bundle-dir | Directory to stage files that will be packed into the CLI zip bundle. | no | dist/release-bundle |
| manifest-asset-name | Asset name for the web installer manifest uploaded to the release. | no | web-installer-manifest.json |
| site-title | Title shown on the installer page. | no | ESP Firmware Installer |
| site-description | Description shown on the installer page. | no | Choose a firmware release and flash it from a Chromium-based browser with esptool-js. |
| default-baud-rate | Default flashing baud rate for the web installer and CLI snippet. | no | 115200 |
Outputs
| name | description |
|---|---|
| release-assets-dir | Directory containing standalone files to upload to the GitHub release. |
| release-bundle-dir | Directory containing the files packed into the CLI zip bundle. |
| pages-dir | Directory containing the merged GitHub Pages site. |
| release-snippet-file | Markdown file that can be appended to the release notes. |
| cli-bundle-file | Zip file containing the release assets for CLI users. |
| manifest-file | Manifest file generated for the web installer. |