https://github.com/zephyrproject-rtos/action-zephyr-setup
GitHub Action to set up Zephyr build environment
https://github.com/zephyrproject-rtos/action-zephyr-setup
actions ci
Last synced: about 2 months ago
JSON representation
GitHub Action to set up Zephyr build environment
- Host: GitHub
- URL: https://github.com/zephyrproject-rtos/action-zephyr-setup
- Owner: zephyrproject-rtos
- License: apache-2.0
- Created: 2024-01-11T15:25:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-02T18:07:32.000Z (2 months ago)
- Last Synced: 2025-05-08T22:08:31.982Z (about 2 months ago)
- Topics: actions, ci
- Homepage:
- Size: 17.6 KB
- Stars: 14
- Watchers: 8
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-zephyr-rtos - action-setup-zephyr - This action initializes a Zephyr based project, downloading the Zephyr SDK and the necessary modules for a West based [Zephyr workspace application](https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app). (Tools / Build & Config)
README
# action-setup-zephyr
This action initializes a Zephyr based project, downloading the Zephyr SDK and
the necessary modules for a West based [Zephyr workspace application][1].
## Basic usage
```yaml
- name: Setup Zephyr project
uses: zephyrproject-rtos/action-zephyr-setup@v1
with:
app-path: example-application
toolchains: arm-zephyr-eabi
```
## Scenarios
### Application and west.yml in an "app" subdirectory
```yaml
- name: Checkout
uses: actions/checkout@v3
- name: Setup Zephyr project
uses: zephyrproject-rtos/action-zephyr-setup@v1
with:
app-path: app
toolchains: arm-zephyr-eabi
- name: Build
run: |
west build app
```
### Application and west.yml at the root of the repository
```yaml
- name: Checkout
uses: actions/checkout@v3
with:
path: app
- name: Setup Zephyr project
uses: zephyrproject-rtos/action-zephyr-setup@v1
with:
app-path: app
toolchains: arm-zephyr-eabi
- name: Build
run: |
west build app
```
### Use a specific SDK version and multiple compilers
```yaml
- name: Setup Zephyr project
uses: zephyrproject-rtos/action-zephyr-setup@v1
with:
app-path: app
toolchains: arm-zephyr-eabi:riscv64-zephyr-elf
sdk-version: 0.16.3
```
## Specify a custom west workspace manifest file name
```yaml
- name: Setup Zephyr project
uses: zephyrproject-rtos/zephyr-setup@v1
with:
app-path: app
toolchains: arm-zephyr-eabi
manifest-file-name: custom_west.yml
```
## Filter west groups and projects
```yaml
- name: Setup Zephyr project
uses: zephyrproject-rtos/zephyr-setup@v1
with:
app-path: app
toolchains: arm-zephyr-eabi
west-group-filter: -hal,-tools,-bootloader,-babblesim
west-project-filter: -nrf_hw_models
```
[1]: https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app