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

trust semantic versioning #538

Merged
merged 36 commits into from
Sep 11, 2024
Merged

trust semantic versioning #538

merged 36 commits into from
Sep 11, 2024

Conversation

JarbasAl
Copy link
Member

@JarbasAl JarbasAl commented Sep 2, 2024

all dependencies should adopt new automations so we can benefit from semver in our requirements.txt before this PR is merged

if we trust semver, next breaking release of any dependency will be 1.0.0

semver adoption tracking:

core dependencies:

core services

skills:

phal:

Summary by CodeRabbit

  • New Features

    • Introduced a new requirements file for audio skills, enhancing audio interaction capabilities.
    • Added new skills for internet connectivity and media playback, expanding available functionalities.
  • Bug Fixes

    • Improved version constraints across various requirements files to ensure compatibility and stability.
  • Documentation

    • Updated dependency management documentation to reflect new and modified skills and version constraints.
  • Chores

    • Cleaned up and structured requirements files for better clarity and management.

Copy link

coderabbitai bot commented Sep 2, 2024

Warning

Rate limit exceeded

@JarbasAl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 1 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 5b878b2 and fb3cd04.

Walkthrough

The changes involve updates to various dependency version constraints across multiple requirements files, enhancing compatibility and stability. New files for specific skill dependencies, such as audio and desktop skills, have been introduced. Existing files have been modified to include upper version limits and additional skills, ensuring a more structured approach to dependency management. The setup script has also been updated to include new audio skill requirements.

Changes

Files Change Summary
requirements/mycroft.txt Updated version constraints for multiple dependencies, allowing broader compatibility with newer versions.
requirements/requirements.txt Added upper version limits for several dependencies to enhance control over installed versions.
requirements/skills-audio.txt Introduced new file listing dependencies for audio-related skills with specified version constraints.
requirements/skills-desktop.txt Added specific dependency for ovos-skill-application-launcher, removing previous placeholder comments.
requirements/skills-essential.txt Restructured version constraints for skills, added new skills, and removed outdated entries.
requirements/skills-gui.txt Modified version specification for ovos-skill-homescreen to include version constraints.
requirements/skills-internet.txt Updated version constraints for internet-related skills and added new skills with specified versions.
requirements/skills-media.txt Specified version constraints for various media-related skills, enhancing dependency management.
setup.py Added entry for 'skills-audio' in the required function, enhancing dependency management.
ovos_core/intent_services/padacioso_service.py Introduced error handling for containers initialization to ensure compatibility with padacioso library versions.
test/unittests/skills/test_intent_service.py Modified shutdown test to refine focus by removing irrelevant entries.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant Requirements
    participant Setup

    Developer->>Requirements: Update version constraints
    Requirements->>Setup: Include new dependencies
    Setup->>Developer: Confirm updated setup
Loading

🐰 "In the garden of code, we hop and play,
With dependencies spruced up in a grand ballet.
New skills bloom bright, old ones refined,
A patchwork of progress, so neatly aligned.
Let's dance through the changes, with joy in our hearts,
For every new version, a fresh start!" 🌼

Possibly related PRs

  • improve_typing #528: Involves updates to type annotations and imports related to IntentMatch, which may indirectly relate to the broader dependency management and compatibility improvements seen in the main PR's updates to version constraints.

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 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.

@JarbasAl JarbasAl added this to the 0.0.8 milestone Sep 10, 2024
@JarbasAl JarbasAl marked this pull request as ready for review September 10, 2024 18:37
@JarbasAl JarbasAl changed the title stable dependencies trust semantic versioning Sep 10, 2024
@JarbasAl JarbasAl added the dependencies Pull requests that update a dependency file label Sep 10, 2024
Copy link

@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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9fa0b49 and d05019f.

Files selected for processing (9)
  • requirements/mycroft.txt (1 hunks)
  • requirements/requirements.txt (1 hunks)
  • requirements/skills-audio.txt (1 hunks)
  • requirements/skills-desktop.txt (1 hunks)
  • requirements/skills-essential.txt (1 hunks)
  • requirements/skills-gui.txt (1 hunks)
  • requirements/skills-internet.txt (1 hunks)
  • requirements/skills-media.txt (1 hunks)
  • setup.py (1 hunks)
Additional context used
LanguageTool
requirements/skills-media.txt

[uncategorized] ~3-~3: A comma might be missing here.
Context: ...m>=0.0.2,<1.0.0 skill-news>=0.0.4,<1.0.0 ovos-skill-pyradios>=0.1.0,<1.0.0 ovos-s...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

requirements/skills-audio.txt

[uncategorized] ~4-~4: A comma might be missing here.
Context: ...1.0.0 ovos-skill-dictation>=0.1.0,<1.0.0 ovos-skill-parrot>=0.0.1,<1.0.0 ovos-ski...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

requirements/mycroft.txt

[locale-violation] ~9-~9: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ....0.0 # default plugins ovos-stt-plugin-server>=0.0.3, <1.0.0 ovos-tts-plugin-mimic>=0...

(PT_BARBARISMS_REPLACE_SERVER)


[locale-violation] ~11-~11: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ...in-mimic>=0.2.8, <1.0.0 ovos-tts-plugin-server>=0.0.2a6, <1.0.0 ovos-ww-plugin-pocket...

(PT_BARBARISMS_REPLACE_SERVER)


[misspelling] ~18-18: Você quis dizer “YouTube”?
Context: ...n_common_play>=0.0.7, <1.0.0 # ovos-ocp-youtube-plugin
=0.0, >=0.0.1 ovos-ocp-m3u-plugi...

(YOUTUBE)

Ruff
setup.py

73-73: SyntaxError: Expected an expression or a '}'

Additional comments not posted (50)
requirements/skills-gui.txt (1)

1-1: LGTM!

The version constraint update for ovos-skill-homescreen looks good. It follows semantic versioning conventions by specifying a minimum version 0.0.3 and an upper limit <1.0.0 before the next major version. This ensures compatibility and stability.

requirements/skills-desktop.txt (1)

1-2: LGTM!

The newly added dependency ovos-skill-application-launcher with the version constraint >=0.1.0,<1.0.0 looks good. It clearly specifies the required package for skills to operate correctly in a Linux desktop environment.

requirements/skills-media.txt (1)

1-6: LGTM!

The newly added dependencies for skills that require audio playback plugins look good:

  • ovos-skill-somafm>=0.0.2,<1.0.0
  • skill-news>=0.0.4,<1.0.0
  • ovos-skill-pyradios>=0.1.0,<1.0.0
  • ovos-skill-local-media>=0.2.0,<1.0.0
  • ovos-skill-youtube-music>=0.1.1,<1.0.0

The version constraints follow semantic versioning conventions by specifying minimum versions and upper limits before the next major versions. This ensures compatibility and stability.

Tools
LanguageTool

[uncategorized] ~3-~3: A comma might be missing here.
Context: ...m>=0.0.2,<1.0.0 skill-news>=0.0.4,<1.0.0 ovos-skill-pyradios>=0.1.0,<1.0.0 ovos-s...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

requirements/skills-audio.txt (7)

1-1: LGTM!

The comment clearly describes the purpose of the file.


2-2: LGTM!

The version constraint for the ovos-skill-boot-finished skill is well-defined and follows the semantic versioning format.


3-3: LGTM!

The version constraint for the ovos-skill-audio-recording skill is well-defined and follows the semantic versioning format.


4-4: LGTM!

The version constraint for the ovos-skill-dictation skill is well-defined and follows the semantic versioning format.

Tools
LanguageTool

[uncategorized] ~4-~4: A comma might be missing here.
Context: ...1.0.0 ovos-skill-dictation>=0.1.0,<1.0.0 ovos-skill-parrot>=0.0.1,<1.0.0 ovos-ski...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)


5-5: LGTM!

The version constraint for the ovos-skill-parrot skill is well-defined and follows the semantic versioning format.


6-6: LGTM!

The version constraint for the ovos-skill-volume skill is well-defined and follows the semantic versioning format.


7-7: LGTM!

The version constraint for the ovos-skill-naptime skill is well-defined and follows the semantic versioning format.

requirements/skills-essential.txt (9)

1-1: LGTM!

The comment clearly describes the purpose of the file.


2-2: LGTM!

The version constraint for the ovos-skill-fallback-unknown skill is well-defined and follows the semantic versioning format.


3-3: LGTM!

The version constraint for the ovos-skill-alerts skill is well-defined and follows the semantic versioning format.


4-4: LGTM!

The version constraint for the ovos-skill-personal skill is well-defined and follows the semantic versioning format.


5-5: LGTM!

The version constraint for the ovos-skill-date-time skill is well-defined and follows the semantic versioning format.


6-6: LGTM!

The version constraint for the ovos-skill-hello-world skill is well-defined and follows the semantic versioning format.


7-7: LGTM!

The version constraint for the skill-wordnet skill is well-defined and follows the semantic versioning format.


8-8: LGTM!

The version constraint for the skill-randomness skill is well-defined and follows the semantic versioning format.


9-9: LGTM!

The version constraint for the ovos-skill-spelling skill is well-defined and follows the semantic versioning format.

requirements/skills-internet.txt (6)

1-1: LGTM!

The comment clearly describes the purpose of the file.


2-2: LGTM!

The version constraint for the ovos-skill-weather skill is well-defined and follows the semantic versioning format.


3-3: LGTM!

The version constraint for the skill-ddg skill is well-defined and follows the semantic versioning format.


4-4: LGTM!

The version constraint for the skill-wolfie skill is well-defined and follows the semantic versioning format.


5-5: LGTM!

The version constraint for the ovos-skill-wikipedia skill is well-defined and follows the semantic versioning format.


6-6: LGTM!

The version constraint for the skill-ovos-fallback-chatgpt skill is well-defined and follows the semantic versioning format.

requirements/requirements.txt (9)

10-10: The past review comment is no longer applicable as the suggested changes have already been incorporated.


9-9: LGTM!

The version constraint update for ovos-utils is approved.


10-10: LGTM!

The version constraint update for ovos_bus_client is approved.


11-11: LGTM!

The version constraint update for ovos-plugin-manager is approved.


12-12: LGTM!

The version constraint update for ovos-config is approved.


13-13: LGTM!

The version constraint update for ovos-lingua-franca is approved.


14-14: LGTM!

The version constraint update for ovos-backend-client is approved.


15-15: LGTM!

The version constraint update for ovos-workshop is approved.


17-17: LGTM!

The version constraint update for ovos-utterance-normalizer is approved.

requirements/mycroft.txt (15)

2-2: Approved version constraint update for ovos_PHAL.

The update broadens the version range to include all versions before 1.0.0, starting from 0.0.5, aligning with the PR objectives.


3-3: Approved version constraint update for ovos-audio.

The update allows for all versions up to 1.0.0, starting from 0.0.2, aligning with the PR objectives.


4-4: Approved version constraint update for ovos-listener.

The update allows for all versions up to 1.0.0, starting from 0.0.3, aligning with the PR objectives.


5-5: Approved version constraint update for ovos-gui.

The update sets a new minimum version at 0.1.0 and allows for all versions up to 1.0.0, aligning with the PR objectives.


6-6: Approved version constraint update for ovos-messagebus.

The update specifies a minimum version at 0.0.1 and allows for all versions up to 1.0.0, aligning with the PR objectives.


9-9: Approved version constraint update for ovos-stt-plugin-server.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.

Note: A static analysis tool suggested translating "server" to "servidor" for Portuguese. However, this is part of the package name and should not be changed.

Tools
LanguageTool

[locale-violation] ~9-~9: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ....0.0 # default plugins ovos-stt-plugin-server>=0.0.3, <1.0.0 ovos-tts-plugin-mimic>=0...

(PT_BARBARISMS_REPLACE_SERVER)


10-10: Approved version constraint update for ovos-tts-plugin-mimic.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.


11-11: Approved version constraint update for ovos-tts-plugin-server.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.

Note: A static analysis tool suggested translating "server" to "servidor" for Portuguese. However, this is part of the package name and should not be changed.

Tools
LanguageTool

[locale-violation] ~11-~11: “server” é um estrangeirismo. É preferível dizer “servidor”.
Context: ...in-mimic>=0.2.8, <1.0.0 ovos-tts-plugin-server>=0.0.2a6, <1.0.0 ovos-ww-plugin-pocket...

(PT_BARBARISMS_REPLACE_SERVER)


13-13: Approved version constraint update for ovos-ww-plugin-pocketsphinx.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.


14-14: Approved version constraint update for ovos-ww-plugin-precise.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.


15-15: Approved version constraint update for ovos-vad-plugin-webrtcvad.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.


17-17: Approved version constraint update for ovos_plugin_common_play.

The update sets a new minimum version at 0.0.7 and allows for all versions up to 1.0.0, aligning with the PR objectives.


19-19: Approved version constraint update for ovos-ocp-m3u-plugin.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.


20-20: Approved version constraint update for ovos-ocp-rss-plugin.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.


22-22: Approved version constraint update for ovos-ocp-news-plugin.

The update allows for all versions up to 1.0.0, aligning with the PR objectives.

setup.py (1)

74-74: Approved addition of 'skills-audio' in the extras_require dictionary.

The addition of 'skills-audio' enhances the setup process by including additional dependencies necessary for audio skills, aligning with the PR objectives.

setup.py Outdated Show resolved Hide resolved
@JarbasAl JarbasAl merged commit 1214b44 into dev Sep 11, 2024
7 checks passed
@JarbasAl JarbasAl deleted the stable-dependencies branch September 11, 2024 00:15
Copy link

codecov bot commented Sep 11, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.

Project coverage is 75.29%. Comparing base (8455d17) to head (fb3cd04).
Report is 3 commits behind head on dev.

Files with missing lines Patch % Lines
ovos_core/intent_services/padacioso_service.py 50.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #538      +/-   ##
==========================================
- Coverage   75.37%   75.29%   -0.08%     
==========================================
  Files          15       15              
  Lines        3086     3089       +3     
==========================================
  Hits         2326     2326              
- Misses        760      763       +3     
Flag Coverage Δ
unittests 75.29% <50.00%> (-0.08%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants