Skip to content
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.

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

[ansible/venv] Use PyPi packages instead of GitHub #229

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

goldyfruit
Copy link
Member

@goldyfruit goldyfruit commented Dec 20, 2024

Summary by CodeRabbit

  • New Features

    • Introduced new dependencies for enhanced functionality, including hivemind-bus-client, hivemind-voice-sat, and ovos-audio[extras].
    • Conditional dependencies added based on locale and CPU capability.
  • Bug Fixes

    • Removed outdated GitHub repository references for certain dependencies.
  • Documentation

    • Updated naming conventions for dependencies to improve consistency.

@goldyfruit goldyfruit added the enhancement New feature or request label Dec 20, 2024
@goldyfruit goldyfruit added this to the Wolfenstein milestone Dec 20, 2024
@goldyfruit goldyfruit requested a review from JarbasAl December 20, 2024 21:13
@goldyfruit goldyfruit self-assigned this Dec 20, 2024
Copy link
Contributor

coderabbitai bot commented Dec 20, 2024

Walkthrough

The pull request updates dependency management for the OVOS Installer by replacing direct GitHub repository references with specific package names across multiple requirement files. The changes focus on HiveMind-related dependencies, introducing more standardized package naming conventions with hyphens and adding several new OVOS and HiveMind packages. The modifications also include conditional dependencies based on system locale, CPU capabilities, and available I2C devices.

Changes

File Changes
ansible/roles/ovos_installer/templates/virtualenv/listener-requirements.txt.j2 - Replaced hivemind_bus_client with hivemind-bus-client
- Removed jarbas-hive-mind
- Added hivemind-core
ansible/roles/ovos_installer/templates/virtualenv/satellite-requirements.txt.j2 - Added multiple new dependencies: hivemind-bus-client, hivemind-voice-sat, ovos-audio[extras], etc.
- Added conditional dependencies for specific locales and CPU capabilities
ansible/roles/ovos_installer/templates/virtualenv/server-requirements.txt.j2 - Removed GitHub repository URLs for HiveMind components
- Added package dependencies: hivemind-bus-client, hivemind-core, hivemind-presence

Poem

🐰 Hop, hop, dependencies dance!
Hyphens replace the old Git stance
OVOS grows with packages bright
HiveMind modules taking flight
A rabbit's code, now clean and neat 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
ansible/roles/ovos_installer/templates/virtualenv/server-requirements.txt.j2 (1)

2-4: Consider pinning package versions for reproducible builds.

While moving from GitHub to PyPi packages improves stability, consider pinning specific versions to ensure reproducible builds and avoid unexpected breaking changes.

-hivemind-bus-client
-hivemind-core
-hivemind-presence
+hivemind-bus-client==<version>
+hivemind-core==<version>
+hivemind-presence==<version>
ansible/roles/ovos_installer/templates/virtualenv/satellite-requirements.txt.j2 (1)

Line range hint 3-8: Consider version pinning for core dependencies.

While the package structure is good, consider pinning versions for reproducibility.

-ovos-audio[extras]
-ovos-classifiers
-ovos-dinkum-listener[extras,linux]
-ovos-PHAL[linux]
-ovos-phal-plugin-ipgeo
-ovos-tts-plugin-polly
+ovos-audio[extras]==<version>
+ovos-classifiers==<version>
+ovos-dinkum-listener[extras,linux]==<version>
+ovos-PHAL[linux]==<version>
+ovos-phal-plugin-ipgeo==<version>
+ovos-tts-plugin-polly==<version>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c26781a and c43be62.

📒 Files selected for processing (3)
  • ansible/roles/ovos_installer/templates/virtualenv/listener-requirements.txt.j2 (1 hunks)
  • ansible/roles/ovos_installer/templates/virtualenv/satellite-requirements.txt.j2 (1 hunks)
  • ansible/roles/ovos_installer/templates/virtualenv/server-requirements.txt.j2 (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • ansible/roles/ovos_installer/templates/virtualenv/listener-requirements.txt.j2
🔇 Additional comments (3)
ansible/roles/ovos_installer/templates/virtualenv/server-requirements.txt.j2 (1)

1-4: LGTM! Successfully migrated from GitHub to PyPi packages.

The transition from GitHub URLs to PyPi packages for HiveMind dependencies is a good improvement that:

  • Reduces build complexity
  • Improves dependency resolution
  • Makes version management easier
ansible/roles/ovos_installer/templates/virtualenv/satellite-requirements.txt.j2 (2)

1-2: LGTM! HiveMind dependencies successfully migrated to PyPi.

The HiveMind dependencies have been properly converted from GitHub URLs to PyPi packages.


Line range hint 10-24: LGTM! Well-structured conditional dependencies.

The conditional dependencies are well organized and properly handle:

  • Locale-specific TTS plugins
  • CPU capability checks
  • Hardware-specific PHAL configurations

This structure ensures that only necessary dependencies are installed based on the system configuration.

Let's verify the Ansible variables used in conditions:

✅ Verification successful

All variables used in the requirements file are properly defined and used consistently across the role

The verification confirms that all conditional variables (ovos_installer_locale, ovos_installer_cpu_is_capable, and ovos_installer_i2c_devices) are properly used throughout the role:

  • ovos_installer_locale is used for language configuration in multiple files including mycroft.conf.j2 and docker composer
  • ovos_installer_cpu_is_capable is used consistently for CPU-dependent features in venv.yml, mycroft.conf.j2, and telemetry
  • ovos_installer_i2c_devices is properly handled as a JSON array for hardware detection in various service configurations

The conditional dependencies in satellite-requirements.txt.j2 align perfectly with the role's overall configuration patterns.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify the Ansible variables used in conditions are defined in the role
rg -A 2 "ovos_installer_(locale|cpu_is_capable|i2c_devices)" ansible/roles/ovos_installer/

Length of output: 6612

@goldyfruit goldyfruit merged commit b56e6d7 into main Dec 20, 2024
8 checks passed
@goldyfruit goldyfruit deleted the feat/hivemind_pypi branch December 20, 2024 21:31
@coderabbitai coderabbitai bot mentioned this pull request Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant