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: update versions and fix license #339

Merged
merged 1 commit into from
Jul 5, 2024
Merged

Conversation

jamescalam
Copy link
Member

@jamescalam jamescalam commented Jul 5, 2024

PR Type

Enhancement, Documentation


Description

  • Updated the __version__ in semantic_router/__init__.py from "0.0.46" to "0.0.50".
  • Updated the project version in pyproject.toml from "0.0.49" to "0.0.50".
  • Changed the license in pyproject.toml from a file reference to "MIT".

Changes walkthrough 📝

Relevant files
Enhancement
__init__.py
Bump version in `__init__.py` to 0.0.50                                   

semantic_router/init.py

  • Updated the __version__ from "0.0.46" to "0.0.50".
+1/-1     
Documentation
pyproject.toml
Update version and change license to MIT in `pyproject.toml`

pyproject.toml

  • Updated the project version from "0.0.49" to "0.0.50".
  • Changed the license from a file reference to "MIT".
  • +2/-4     

    💡 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 documentation Improvements or additions to documentation enhancement Enhancement to existing features labels Jul 5, 2024
    Copy link

    github-actions bot commented Jul 5, 2024

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    None

    Copy link

    github-actions bot commented Jul 5, 2024

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Maintainability
    Ensure consistent versioning across project files

    It's recommended to use semantic versioning consistently. Since the version in
    pyproject.toml was updated from '0.0.49' to '0.0.50', the version in init.py should
    also be updated from '0.0.46' to '0.0.50' to maintain consistency across the project.

    semantic_router/init.py [7]

    +__version__ = "0.0.50"
     
    -
    Suggestion importance[1-10]: 9

    Why: The suggestion correctly identifies the need for consistent versioning across project files, which is crucial for maintainability and avoiding confusion.

    9
    Legal
    Verify and correct the license specification to ensure legal coverage

    The license information in pyproject.toml was changed from a reference to a LICENSE file
    to a direct "MIT" string. Ensure that this change reflects the project's licensing
    intentions accurately, as direct string might not provide the same legal coverage or
    detail as the LICENSE file.

    pyproject.toml [17]

    -license = "MIT"
    +license = {file = "LICENSE"}
     
    Suggestion importance[1-10]: 8

    Why: The suggestion addresses a potential legal issue by recommending the use of a LICENSE file reference, which typically provides more comprehensive legal coverage than a simple string.

    8
    Best practice
    Implement version control mechanisms to manage version updates

    Consider adding a version control to ensure that the version number updates are tracked
    and managed properly. This can be done by adding a script or a CI/CD pipeline step that
    checks version consistency across different files.

    pyproject.toml [3]

    +version = "0.0.50"
     
    -
    Suggestion importance[1-10]: 7

    Why: The suggestion is valuable for long-term maintainability and best practices, although it is not immediately critical for the current PR.

    7

    @jamescalam jamescalam merged commit 265f27a into main Jul 5, 2024
    6 checks passed
    @jamescalam jamescalam deleted the james/sr-license-fix branch July 5, 2024 06:39
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation 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