Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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: 3 months ago
JSON representation

GitHub Action to set up Zephyr build environment

Awesome Lists containing this project

README

        

# action-setup-zephyr (experimental)

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

[1]: https://docs.zephyrproject.org/latest/develop/application/index.html#zephyr-workspace-app