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

chore: v0.0.41 release #281

Merged
merged 2 commits into from
May 15, 2024
Merged

chore: v0.0.41 release #281

merged 2 commits into from
May 15, 2024

Conversation

jamescalam
Copy link
Member

@jamescalam jamescalam commented May 15, 2024

PR Type

enhancement


Description

  • Updated the version number in semantic_router/__init__.py and pyproject.toml to 0.0.41.
  • Adjusted the installation guide in docs/encoders/bedrock.ipynb to be version-agnostic and reflect the new version support.

Changes walkthrough 📝

Relevant files
Configuration changes
__init__.py
Update package version in __init__.py                                       

semantic_router/init.py

  • Updated the version number from 0.0.40 to 0.0.41.
+1/-1     
pyproject.toml
Update project version in pyproject.toml                                 

pyproject.toml

  • Incremented the project version to 0.0.41.
+1/-1     
Documentation
bedrock.ipynb
Update documentation for Bedrock model support                     

docs/encoders/bedrock.ipynb

  • Modified the installation guide to reflect the new version.
  • Removed the specific version dependency in the pip install command.
  • +2/-2     

    💡 PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    @github-actions github-actions bot added the enhancement Enhancement to existing features label May 15, 2024
    Copy link

    PR Description updated to latest commit (ccd98a7)

    Copy link

    PR Review 🔍

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are straightforward and involve only version updates and a minor adjustment in the installation guide. The PR is small and the changes are clear, making it easy to review.

    🧪 Relevant tests

    No

    ⚡ Possible issues

    No

    🔒 Security concerns

    No

    Code feedback:
    relevant filedocs/encoders/bedrock.ipynb
    suggestion      

    Consider adding a version specifier for the semantic-router[bedrock] package to ensure users install a compatible version. This can prevent potential compatibility issues with future versions. [important]

    relevant line"!pip install -qU \"semantic-router[bedrock]\""

    relevant filesemantic_router/__init__.py
    suggestion      

    Ensure that all dependencies and internal usages of the __version__ variable are updated to reflect the new version to maintain consistency across the project. [important]

    relevant line__version__ = "0.0.41"

    relevant filepyproject.toml
    suggestion      

    Verify that the version bump in pyproject.toml aligns with the semantic versioning standards, especially if there are API changes, new features, or bug fixes. [medium]

    relevant lineversion = "0.0.41"

    Copy link

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Update the version number in the markdown documentation to match the latest release

    Update the version number in the markdown documentation to reflect the new version 0.0.41
    instead of 0.0.40 to maintain consistency with the latest release.

    docs/encoders/bedrock.ipynb [35]

    -"We start by installing semantic-router. Support for the new `Bedrock` embedding models was added in `0.0.40`."
    +"We start by installing semantic-router. Support for the new `Bedrock` embedding models was added in `0.0.41`."
     
    Suggestion importance[1-10]: 10

    Why: The suggestion correctly identifies the need to update the version number in the markdown documentation to match the new version 0.0.41 in the PR, ensuring consistency and accuracy in the documentation.

    10
    Best practice
    Ensure the pip install command in the notebook specifies the latest package version

    Update the pip install command in the Jupyter notebook to install the latest version
    0.0.41 of semantic-router to ensure users are guided to install the correct, updated
    package.

    docs/encoders/bedrock.ipynb [44]

    -"!pip install -qU \"semantic-router[bedrock]\""
    +"!pip install -qU \"semantic-router[bedrock]==0.0.41\""
     
    Suggestion importance[1-10]: 10

    Why: The suggestion is accurate in recommending an update to the pip install command to specify the latest version 0.0.41, which aligns with the updated version in the PR, ensuring users install the correct version.

    10

    Copy link

    codecov bot commented May 15, 2024

    Codecov Report

    All modified and coverable lines are covered by tests ✅

    Project coverage is 80.97%. Comparing base (414bf4c) to head (ccd98a7).
    Report is 1 commits behind head on main.

    Additional details and impacted files
    @@           Coverage Diff           @@
    ##             main     #281   +/-   ##
    =======================================
      Coverage   80.97%   80.97%           
    =======================================
      Files          45       45           
      Lines        2676     2676           
    =======================================
      Hits         2167     2167           
      Misses        509      509           

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

    @jamescalam jamescalam merged commit bbe4b38 into main May 15, 2024
    6 checks passed
    @jamescalam jamescalam deleted the james/v0.0.41 branch May 15, 2024 02:08
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    enhancement Enhancement to existing features Review effort [1-5]: 2
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant