Skip to content

Commit bbc54dd

Browse files
committed
Upload to the ESP component registry
1 parent 6cd0b34 commit bbc54dd

25 files changed

Lines changed: 127 additions & 23 deletions

File tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: Upload ESP Component Registry
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- kilted
8+
workflow_dispatch:
9+
10+
jobs:
11+
upload_components:
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: read
15+
id-token: write
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Upload component to the component registry
20+
uses: espressif/upload-components-ci-action@v2
21+
with:
22+
components: "micro_ros_espidf_component:."
23+
namespace: "micro-ros"
24+
dry_run: ${{ github.event_name == 'pull_request' || github.ref_name != 'kilted' }}

‎README.md‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,45 @@ In order to select it, use `idf.py menuconfig` and go to `micro-ROS Settings > m
2929

3030
## Usage
3131

32-
You can clone this repo directly in the `components` folder of your project.
32+
### From the ESP Component Registry
33+
34+
To align with the semantic versioning scheme of the ESP Component Registry, the ROS 2 distribution release year is used as the major version of the component:
35+
36+
| ROS 2 distro | Version |
37+
|:------------:|:-------:|
38+
| humble | 22.x.y |
39+
| iron | 23.x.y |
40+
| jazzy | 24.x.y |
41+
| kilted | 25.x.y |
42+
| lyrical | 26.x.y |
43+
44+
Rolling is published as a prerelease of the next version, for example `27.0.0-rolling.20260806`.
45+
46+
This branch corresponds to kilted and publishes `25.x.y` versions.
47+
48+
Add the component to your project with the IDF Component Manager:
49+
50+
```bash
51+
idf.py add-dependency "micro-ros/micro_ros_espidf_component^25"
52+
```
53+
54+
Or declare it in your main component's `idf_component.yml`:
55+
56+
```yaml
57+
dependencies:
58+
micro-ros/micro_ros_espidf_component: "^25"
59+
```
60+
61+
Then build your project as usual. The Component Manager downloads the matching `25.x.y` release for Kilted.
62+
63+
### From this repository
64+
65+
You can also clone this repo into the `components` folder of your project:
66+
67+
```bash
68+
cd your_project/components
69+
git clone -b kilted https://github.com/micro-ROS/micro_ros_espidf_component.git
70+
```
3371

3472
If you encounter issues during the build process, ensure that you are running in a clean shell environment _without_ the ROS 2 setup script sourced.
3573

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
cmake_minimum_required(VERSION 3.5)
22

3-
set (EXTRA_COMPONENT_DIRS "./../../.")
4-
53
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
64
project(addtwoints_server)
75

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dependencies:
2+
micro-ros/micro_ros_espidf_component:
3+
version: "^25.0.0"
4+
override_path: "../../../"
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
cmake_minimum_required(VERSION 3.5)
22

3-
set (EXTRA_COMPONENT_DIRS "./../../.")
4-
53
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
64
project(handle_static_types)
75

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dependencies:
2+
micro-ros/micro_ros_espidf_component:
3+
version: "^25.0.0"
4+
override_path: "../../../"
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
cmake_minimum_required(VERSION 3.5)
22

3-
set (EXTRA_COMPONENT_DIRS "./../../.")
4-
53
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
64
project(int32_publisher)
75

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dependencies:
2+
micro-ros/micro_ros_espidf_component:
3+
version: "^25.0.0"
4+
override_path: "../../../"
Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
cmake_minimum_required(VERSION 3.5)
22

3-
set (EXTRA_COMPONENT_DIRS "./../../.")
4-
53
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
64
project(int32_publisher)
75

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dependencies:
2+
micro-ros/micro_ros_espidf_component:
3+
version: "^25.0.0"
4+
override_path: "../../../"

0 commit comments

Comments
 (0)