Skip to content

build: rename generate_docs feature to use_ros_shim. Only publish use_ros_shim feature to crates.io to avoid requiring ROS #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 8, 2025
Merged

build: rename generate_docs feature to use_ros_shim. Only publish use_ros_shim feature to crates.io to avoid requiring ROS #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions release-plz.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[workspace]

[[package]]
name = "rosidl_runtime_rs"
publish_features = ["use_ros_shim"]
publish_all_features = false
4 changes: 2 additions & 2 deletions rosidl_runtime_rs/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ serde = { version = "1", optional = true }
default = []
# This feature is solely for the purpose of being able to generate documetation without a ROS installation
# The only intended usage of this feature is for docs.rs builders to work, and is not intended to be used by end users
generate_docs = []
use_ros_shim = []

[dev-dependencies]
# Needed for writing property tests
Expand All @@ -34,4 +34,4 @@ serde_json = "1"
cfg-if = "1.0.0"

[package.metadata.docs.rs]
features = ["generate_docs"]
features = ["use_ros_shim"]
4 changes: 2 additions & 2 deletions rosidl_runtime_rs/build.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
cfg_if::cfg_if! {
if #[cfg(not(feature="generate_docs"))] {
if #[cfg(not(feature="use_ros_shim"))] {
use std::env;
use std::path::Path;

Expand All @@ -19,7 +19,7 @@ cfg_if::cfg_if! {
}

fn main() {
#[cfg(not(feature = "generate_docs"))]
#[cfg(not(feature = "use_ros_shim"))]
{
let ament_prefix_path_list = get_env_var_or_abort(AMENT_PREFIX_PATH);
for ament_prefix_path in ament_prefix_path_list.split(':') {
Expand Down