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.

Basic usage

- 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

- name: Checkout
  uses: actions/checkout@v4

- name: Set up Python
  uses: actions/setup-python@v5
  with:
    python-version: 3.12

- 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

- name: Checkout
  uses: actions/checkout@v4
  with:
    path: app

- name: Set up Python
  uses: actions/setup-python@v5
  with:
    python-version: 3.12

- 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

- 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
    sdk-install-dir: /opt/zephyr-sdk-0.16.3
    toolchain-variant: zephyr

### Override Zephyr repository source

```yaml
- name: Setup Zephyr project
  uses: zephyrproject-rtos/action-zephyr-setup@v1
  with:
    app-path: app
    toolchains: arm-zephyr-eabi
    zephyr-repo-url: https://github.com/AmbiqMicro/zephyr-ambiq-internal

## 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

- 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

Specify a west version

- name: Setup Zephyr project
  uses: zephyrproject-rtos/zephyr-setup@v1
  with:
    app-path: app
    toolchains: arm-zephyr-eabi
    west-version: 1.3.0