https://github.com/elehobica/build-pico
GitHub Action to build projects for Raspberry Pi Pico series
https://github.com/elehobica/build-pico
actions raspberry-pi-pico raspberry-pi-pico-2 rp2040 rp2350
Last synced: 3 months ago
JSON representation
GitHub Action to build projects for Raspberry Pi Pico series
- Host: GitHub
- URL: https://github.com/elehobica/build-pico
- Owner: elehobica
- License: bsd-2-clause
- Created: 2025-03-16T11:50:23.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-05-14T13:33:26.000Z (5 months ago)
- Last Synced: 2025-05-14T14:41:56.515Z (5 months ago)
- Topics: actions, raspberry-pi-pico, raspberry-pi-pico-2, rp2040, rp2350
- Language: Shell
- Homepage:
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Build-Pico
This is a GitHub Action for building projects with C/C++ for the Raspberry Pi Pico series.
[](https://github.com/elehobica/build-pico/actions/workflows/build-test.yml)
## Overview
* Pico SDK 2.1.1
* Projects with CMakeLists.txt
## Usage
To use this GitHub Action in your workflow, add the following step to your `.github/workflows/your-workflow.yml` file:
* For Raspberry Pi Pico
```yaml
name: Build Raspberry Pi Pico Project
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Build-pico
uses: elehobica/build-pico@v1
```
* For Raspberry Pi Pico 2
```yaml
name: Build Raspberry Pi Pico 2 Project
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Build-pico
uses: elehobica/build-pico@v1
with:
platform: rp2350
board: pico2
```
## Inputs
* path
Target path to the project directory.
The directory should be desinated as the relative path from the GitHub Action's working directory.
`CMakesList.txt` must be under the directory.
Default is `.`, supposing that the action is used just after _checkout_ and `CMakesList.txt` exists in the root directory of the repository.
* jobs
Number of jobs to be applied to `make`.
Default is calculated as the number of the CPU + 1.
* build
Build directory. Default is `build`.
The directory should be desinated as the relative path from the _path_.
* keep
Not to delete the build directory.
Default is 0, which deletes the build directory before applying `cmake` if it exists.
* platform
Platform to be designated with `cmake`.
It will be givens as `-DPICO_PLATFORM=`.
Default is _rp2040_.
If the target board is Raspberry Pi Pico 2, it should be _rp2350_.
* board
Board to be designated with `cmake`.
It will be givens as `-DPICO_BOARD=`.
Default is _pico_.
If the target board is Raspberry Pi Pico 2, it should be _pico2_.
* cmake_options
Additional options to be given to `cmake`.