search

OpenVoiceOS / ovos-utils

Apache License 2.0
3 stars 8 forks source link

STABLE RELEASE - 0.1.0 #264

Closed github-actions[bot] closed 1 month ago

github-actions[bot] commented 2 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes encompass the introduction of new configuration files for dependency management, significant updates to GitHub Actions workflows, and enhancements to various modules within the codebase. Key modifications include the removal of deprecated functions, restructuring of logging and media handling functionalities, and an update to the versioning scheme. Additionally, the documentation has been improved with a new README and a restructured CHANGELOG, while unit tests have been added or modified to align with the latest code changes.

Changes

Files Change Summary
.github/dependabot.yml New configuration file for GitHub's Dependabot to automate dependency updates for Python packages in the /requirements directory on a weekly schedule.
.github/workflows/*.yml Modifications in GitHub Actions workflows: removal of dependency installation from a requirements file, removal of release creation steps, and updates to Python version matrix in unit tests.
CHANGELOG.md Restructured changelog with new sections for enhancements and bug fixes, replacing specific version tags with a generic [Unreleased] tag.
README.md Newly created documentation outlining installation instructions and command-line tools for the ovos-utils library, enhancing user understanding.
ovos_utils/__init__.py Removed deprecated functions and cleaned up imports, streamlining the codebase.
ovos_utils/events.py Simplified EventSchedulerInterface constructor by removing deprecated parameters and updating method signatures.
ovos_utils/file_utils.py Added ensure_directory_exists function and modified get_cache_directory logic for platform-specific behavior.
ovos_utils/gui.py Refactored GUI-related classes and methods, replacing deprecated Mycroft components and enhancing clarity.
ovos_utils/log.py Introduced new logging functions and refactored existing methods to improve configuration handling and responsiveness.
ovos_utils/log_parser.py New file implementing a logging utility for parsing and displaying log data, including a command-line interface.
ovos_utils/messagebus.py Significant refactoring to remove deprecated functions and encourage the use of ovos_bus_client.util.
ovos_utils/security.py Reorganized import statements for better readability without changing functionality.
ovos_utils/signal.py Deprecated the entire module, marking functions and the module itself as deprecated, and refactored ensure_directory_exists.
ovos_utils/system.py Removed MycroftRootLocations class, deprecated system operation functions, and introduced check_service_installed.
ovos_utils/version.py Updated versioning information, incrementing VERSION_MINOR and resetting VERSION_BUILD.
requirements/*.txt Updated version constraints for existing dependencies and added new ones, reflecting a shift towards more recent library versions.
setup.py Updated package metadata, reduced included packages, and added console script entry points.
test/unittests/*.py Enhanced and modified unit tests across various modules, including the introduction of new tests and the removal of deprecated or incomplete tests.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Dependabot
    participant CI/CD
    participant Codebase

    User->>GitHub: Push changes
    GitHub->>Dependabot: Check for dependency updates
    Dependabot->>Codebase: Propose updates
    GitHub->>CI/CD: Trigger workflow
    CI/CD->>Codebase: Run tests
    CI/CD->>GitHub: Report results

🐰 "Hoppity hop, the code does gleam,
With updates and fixes, it’s a coder's dream!
Dependencies managed, workflows refined,
A new README shines, with knowledge aligned.
Bugs are squashed, and tests now sing,
Oh what joy these changes bring!" 🐇

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
Early access features: disabled We are currently testing the following features in early access: - **Anthropic `claude-3-5-sonnet` for code reviews**: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues on the [discussion post](https://discordapp.com/channels/1134356397673414807/1279579842131787838).
JarbasAl commented 2 months ago

@coderabbitai review

coderabbitai[bot] commented 2 months ago
Actions performed Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.