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.60 #390

Merged
merged 1 commit into from
Aug 19, 2024
Merged

chore: v0.0.60 #390

merged 1 commit into from
Aug 19, 2024

Conversation

jamescalam
Copy link
Member

@jamescalam jamescalam commented Aug 19, 2024

PR Type

enhancement


Description

  • Updated the project release version in the Sphinx documentation configuration file to 0.0.60.
  • Updated the __version__ attribute in the __init__.py file to 0.0.60.
  • Updated the package version in pyproject.toml to 0.0.60.

Changes walkthrough 📝

Relevant files
Documentation
conf.py
Update project release version in Sphinx configuration     

docs/source/conf.py

  • Updated the release version from 0.0.59 to 0.0.60.
+1/-1     
Enhancement
__init__.py
Update package version in `__init__.py`                                   

semantic_router/init.py

  • Updated the __version__ attribute from 0.0.59 to 0.0.60.
+1/-1     
Configuration changes
pyproject.toml
Update version in `pyproject.toml`                                             

pyproject.toml

  • Updated the package version from 0.0.59 to 0.0.60.
+1/-1     

💡 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 Aug 19, 2024
Copy link

PR Reviewer Guide 🔍

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

Copy link

github-actions bot commented Aug 19, 2024

PR Code Suggestions ✨

CategorySuggestion                                                                                                                                    Score
Maintainability
Use a centralized version number to maintain consistency across the project

To maintain consistency and avoid manual errors in future updates, consider using a
single source of truth for the version number. This could be achieved by importing
the version from a central configuration file or module.

docs/source/conf.py [18]

-release = "0.0.60"
+from config import VERSION
+release = VERSION
 
Suggestion importance[1-10]: 8

Why: Centralizing the version number helps maintain consistency and reduces the risk of errors during updates, which is a significant improvement for maintainability.

8
Centralize the version number to ensure consistency and ease of maintenance

Similar to the previous suggestion, to avoid discrepancies and manual errors in
version updates, import the version number from a central configuration file or
module.

semantic_router/init.py [7]

-__version__ = "0.0.60"
+from config import VERSION
+__version__ = VERSION
 
Suggestion importance[1-10]: 8

Why: This suggestion aligns with best practices for maintainability by centralizing the version number, thus preventing discrepancies and manual errors.

8
Automation
Automate the version number updates to prevent inconsistencies and errors

To ensure that the version number is consistent across all files and reduce the risk
of human error during updates, consider using a script or build tool to
automatically update this value based on a single source of truth.

pyproject.toml [3]

-version = "0.0.60"
+version = "{{VERSION}}"
 
Suggestion importance[1-10]: 7

Why: Automating version updates is a good practice to ensure consistency and reduce human error, though it requires additional setup and tooling.

7

Copy link

codecov bot commented Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 64.45%. Comparing base (1bed311) to head (b01cb98).
Report is 40 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #390      +/-   ##
==========================================
- Coverage   68.18%   64.45%   -3.73%     
==========================================
  Files          45       46       +1     
  Lines        3127     3376     +249     
==========================================
+ Hits         2132     2176      +44     
- Misses        995     1200     +205     

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

@jamescalam jamescalam merged commit db451eb into main Aug 19, 2024
4 of 8 checks passed
@jamescalam jamescalam deleted the james/v0.0.60 branch August 19, 2024 16:34
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]: 1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant