particle-iot/Particle Compile
Compiles application source code
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| particle-platform-name | The platform name to target the compilation. Example: photon, p1, electron, argon, asom, boron | yes | "" |
| particle-access-token | Particle access token. If provided, the action will use the Particle Cloud Compiler instead of compiling within the GitHub Action runner | no | "" |
| device-os-version | Target Device OS firmware version. Allowed values: default, latest, latest-lts, or a semver version number. Example: latest, latest-lts, 4.x, ^5.3.0, 1.4.4 | no | default |
| sources-folder | Path to directory with sources to compile. Example: src | no | . |
| auto-version | If true, the action will automatically increment the product firmware version. See AUTO_VERSION.md for more details. | no | false |
| auto-version-macro-name | Name of the macro that contains the product firmware version. | no | PRODUCT_VERSION |
Outputs
| name | description |
|---|---|
| firmware-path | Path to the compiled firmware binary file. |
| target-path | Path to the folder with compiled firmware files and their associated object files. The folder includes the firmware binary, ELF, HEX, and MAP files, along with object files. Not available when particle-access-token is set (cloud compile). |
| device-os-version | This output contains the actual Device OS version used for compilation. |
| firmware-version | The product firmware version integer. This output is undefined when sources are not a product firmware. |
| firmware-version-updated | Boolean value indicating whether the product firmware version was updated. Can only be true with auto-version enabled. |