Skip to content

Add festival stub entry for NixOS#52040

Open
wentasah wants to merge 1 commit into
ros:masterfrom
wentasah:festival-nixos
Open

Add festival stub entry for NixOS#52040
wentasah wants to merge 1 commit into
ros:masterfrom
wentasah:festival-nixos

Conversation

@wentasah

Copy link
Copy Markdown
Contributor

Festival is not available in nixpkgs. There were some attempts to package it, but it seems to be complicated. The soud_play package, which is being ported to ROS 2, depends on it, but only via exec_depend and is still useful without festival. The only place, where festival is needed is here.

Therefore, to have at least some sound_play functionality available with Nix, we add festival-stub attribute to nix-ros-overlay (the PR will be merged after this one), which allows building the relevant packages. If somebody uses the festival functionality, they'll see the error message at runtime.

Festival is not available in nixpkgs. There were some attempts to
package it [1], but it seems to be complicated. The soud_play package,
which is being ported to ROS 2, depends on it, but only via
exec_depend and is still useful without festival. The only place,
where festival is needed is [2].

Therefore, to have at least some sound_play functionality available
with Nix, we add festival-stub attribute to nix-ros-overlay [3], which
allows building the relevant packages. If somebody uses the festival
functionality, they'll see the error message [2] at runtime.

[1]: https://github.com/NixOS/nixpkgs/blob/50338ea4bce54b50d184d68d8fb2885e45053f81/pkgs/development/python-modules/phonemizer/default.nix#L52
[2]: https://github.com/ros-drivers/audio_common/blob/db2770b0ad703c474039914937974c764dc94351/sound_play/scripts/soundplay_node.py#L376-L386
[3]: lopsided98/nix-ros-overlay#876

Signed-off-by: Michal Sojka <michal.sojka@cvut.cz>
@wentasah wentasah requested a review from a team as a code owner June 13, 2026 08:57
@github-actions github-actions Bot added the rosdep Issue/PR is for a rosdep key label Jun 13, 2026

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for sending a pull request to ROS distro!

This is an automated tool that helps check your pull request for correctness.
This tool checks a number of attributes associated with your ROS package and generates a report that helps our reviewers merge your pull request in a timely fashion. Here are a few things to consider when sending adding or updating a package to ROS Distro.
ROS Distro includes a very helpful CONTRIBUTING.md file that we recommend reading if it is your first time submitting a package.
Please also read the ROS Distro review guidelines which summarizes this release process.

ROS Distro Considerations

Package Considerations

Having your package included in a ROS Distro is a badge of quality, and we recommend that package developers strive to create packages of the highest quality. We recommend package developers review the following resources before submitting their package.

Need Help?

Please post your questions to Robotics Stack Exchange or refer to the Infrastructure General channel on our Zulip server.


For changes related to rosdep:

  • ✅ Platforms for new rosdep rules are valid

For changes related to yamllint:

  • ✅ All new lines of YAML pass linter checks

@mergify

mergify Bot commented Jun 19, 2026

Copy link
Copy Markdown

Tick the box to add this pull request to the merge queue (same as @mergifyio queue).

  • Queue this pull request

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rosdep Issue/PR is for a rosdep key

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants