-
-
Notifications
You must be signed in to change notification settings - Fork 61
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(main): release 0.17.0 #808
Conversation
471bb6f
to
0df4cf2
Compare
Just adding a note, when this gets released we need to update the wiki for Overseerr and make an announcement of its change too. |
183b0a9
to
7c10a9d
Compare
And also api path changes for advanced users along with api_key requirements |
And the filesize filter settings. |
af808fe
to
602176b
Compare
831f46a
to
3b57fff
Compare
@coderabbitai review |
✅ Actions performedReview triggered.
|
WalkthroughThe changes in this pull request include updates to the changelog and the Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
pyproject.toml (2)
Line range hint
59-59
: Consider consolidating pytest dependencies.The pytest dependency is specified in both
[tool.poetry.group.dev.dependencies]
and[tool.poetry.group.test.dependencies]
with the same version (^8.3.2). Consider maintaining it in just one location to avoid potential version conflicts in the future.[tool.poetry.group.dev.dependencies] - pytest = "^8.3.2" pytest-mock = "^3.14.0"
Also applies to: 76-76
Line range hint
1-77
: Document new dependency requirements in README.Given the significant changes in dependencies and the addition of new features (manual torrent adding, Trakt integration, etc.), consider updating the project's README or documentation to reflect:
- Minimum Python version requirements
- New optional dependencies for specific features
- Configuration requirements for new features (especially bearer authentication and rate limiting)
CHANGELOG.md (1)
8-14
: Consider adding more descriptive details for some features.While the feature entries follow the conventional format, some could benefit from more descriptive messages to better convey the impact and scope of changes. For example:
- "stream management endpoints" could specify which endpoints were added
- "we now server sse via /stream" has a typo ("server" -> "serve") and could explain the purpose/benefit of SSE
Apply this diff to fix the typo:
-* we now server sse via /stream ([efbc471](https://github.com/rivenmedia/riven/commit/efbc471e4f4429c098df2a601b3f3c42b98afbb7)) +* we now serve SSE via /stream ([efbc471](https://github.com/rivenmedia/riven/commit/efbc471e4f4429c098df2a601b3f3c42b98afbb7))
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
CHANGELOG.md
(1 hunks)pyproject.toml
(1 hunks)
🔇 Additional comments (5)
pyproject.toml (3)
3-3
: Version bump looks good!
The version increment to 0.17.0 aligns with the significant feature additions and changes described in the PR objectives.
Line range hint 24-24
: Verify SQLAlchemy 2.0 compatibility.
The update to SQLAlchemy 2.0 is a major version change that might introduce breaking changes. The PR objectives don't mention database-related changes, so we should verify the compatibility.
#!/bin/bash
# Description: Check for SQLAlchemy-specific code patterns that might need updates for 2.0
echo "Checking for potential SQLAlchemy compatibility issues..."
# Look for common SQLAlchemy patterns that changed in 2.0
rg -l "from sqlalchemy import *" || echo "No wildcard imports found (good!)"
# Check for session usage patterns that changed in 2.0
ast-grep --pattern 'Session.query($$$)' || echo "No legacy Session.query usage found (good!)"
# Check for engine/connection patterns
ast-grep --pattern 'create_engine($$$, future=True)' || echo "No legacy engine creation found"
Consider documenting any required SQLAlchemy migration steps in the release notes if breaking changes are identified.
Also applies to: 33-33, 36-36, 37-37
Line range hint 52-53
: Verify compatibility of new dependencies.
The addition of rate limiting and caching libraries aligns with the PR objectives for improved session management. However, let's verify the compatibility of these versions with the project's Python version requirement (^3.11).
Also applies to: 65-65
✅ Verification successful
The previous script didn't provide the Python version requirements as intended. Let me try a different approach to verify the compatibility.
All new dependencies are compatible with project's Python requirement
The project requires Python ^3.11, and all new dependencies support this version:
- httpx 0.27.0: requires Python >=3.8
- requests-ratelimiter 0.7.0: requires Python >=3.7,<4.0
- requests-cache 1.2.1: requires Python >=3.8
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check minimum Python version requirements for new dependencies
echo "Checking Python version requirements for new dependencies..."
for pkg in "requests-ratelimiter==0.7.0" "requests-cache==1.2.1" "httpx==0.27.0"; do
pip debug --verbose --index-url https://pypi.org/simple required-python-version "$pkg"
done
Length of output: 560
Script:
#!/bin/bash
# Check if pyproject.toml contains Python version constraint
echo "Python version requirement in pyproject.toml:"
rg "python\s*=" pyproject.toml
# Check dependencies' metadata
echo -e "\nChecking httpx metadata:"
curl -s https://pypi.org/pypi/httpx/0.27.0/json | jq '.info.requires_python'
echo -e "\nChecking requests-ratelimiter metadata:"
curl -s https://pypi.org/pypi/requests-ratelimiter/0.7.0/json | jq '.info.requires_python'
echo -e "\nChecking requests-cache metadata:"
curl -s https://pypi.org/pypi/requests-cache/1.2.1/json | jq '.info.requires_python'
Length of output: 675
CHANGELOG.md (2)
3-4
: LGTM! Version header follows conventional changelog format.
The version header correctly includes:
- Version number with link to GitHub compare view
- Release date in parentheses
19-33
: LGTM! Bug fixes are well documented.
The bug fixes section:
- Follows conventional commit format
- Includes links to issues and commit hashes
- Provides clear descriptions of what was fixed
3b57fff
to
0ba69f1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
CHANGELOG.md (2)
8-14
: Maintain consistent capitalization and punctuation in feature entries.Some entries start with lowercase letters while others start with uppercase. For better readability and consistency:
- Start each entry with a capital letter
- End each entry with a period
- Use consistent verb tense (present tense preferred)
Apply this diff to fix the inconsistencies:
-* add manual torrent adding ([#785](https://github.com/rivenmedia/riven/issues/785)) ([acb22ce](https://github.com/rivenmedia/riven/commit/acb22ce9bb54a09a542e1a587181eb731700243e)) -* Add Most Wanted items from Trakt ([#777](https://github.com/rivenmedia/riven/issues/777)) ([325df42](https://github.com/rivenmedia/riven/commit/325df42989e8d6d841ab625284c54d78b9dc02d1)) -* auth bearer authentication ([0de32fd](https://github.com/rivenmedia/riven/commit/0de32fd9e7255c8c91aae4cecb428cabe180aea9)) -* enhance session management and event processing ([#842](https://github.com/rivenmedia/riven/issues/842)) ([13aa94e](https://github.com/rivenmedia/riven/commit/13aa94e5587661770d385d634fa1a3cef9b0d882)) -* filesize filter ([d2f8374](https://github.com/rivenmedia/riven/commit/d2f8374ae95fc763842750a67d1d9b9f3c545a8d)) -* stream management endpoints ([d75149e](https://github.com/rivenmedia/riven/commit/d75149eb5b246bf7312ddb3d3fac85417e2cb215)) -* we now server sse via /stream ([efbc471](https://github.com/rivenmedia/riven/commit/efbc471e4f4429c098df2a601b3f3c42b98afbb7)) +* Adds manual torrent adding functionality. ([#785](https://github.com/rivenmedia/riven/issues/785)) ([acb22ce](https://github.com/rivenmedia/riven/commit/acb22ce9bb54a09a542e1a587181eb731700243e)) +* Adds Most Wanted items from Trakt. ([#777](https://github.com/rivenmedia/riven/issues/777)) ([325df42](https://github.com/rivenmedia/riven/commit/325df42989e8d6d841ab625284c54d78b9dc02d1)) +* Implements bearer authentication. ([0de32fd](https://github.com/rivenmedia/riven/commit/0de32fd9e7255c8c91aae4cecb428cabe180aea9)) +* Enhances session management and event processing. ([#842](https://github.com/rivenmedia/riven/issues/842)) ([13aa94e](https://github.com/rivenmedia/riven/commit/13aa94e5587661770d385d634fa1a3cef9b0d882)) +* Adds filesize filter functionality. ([d2f8374](https://github.com/rivenmedia/riven/commit/d2f8374ae95fc763842750a67d1d9b9f3c545a8d)) +* Adds stream management endpoints. ([d75149e](https://github.com/rivenmedia/riven/commit/d75149eb5b246bf7312ddb3d3fac85417e2cb215)) +* Implements Server-Sent Events (SSE) via /stream endpoint. ([efbc471](https://github.com/rivenmedia/riven/commit/efbc471e4f4429c098df2a601b3f3c42b98afbb7))
19-33
: Maintain consistent capitalization and punctuation in bug fix entries.Similar to the feature entries, the bug fix entries should follow consistent formatting.
Apply this diff to fix the inconsistencies:
-* add default value for API_KEY ([bc6ff28](https://github.com/rivenmedia/riven/commit/bc6ff28ff5b1d1632f2dd2ca64743c4012ccc396)) -* add python-dotenv to load .env variables ([65a4aec](https://github.com/rivenmedia/riven/commit/65a4aec275a1f7768a77ef0227d6fb402f9a8612)) -* correct type hint for incomplete_retries in StatsResponse ([#839](https://github.com/rivenmedia/riven/issues/839)) ([f91ffec](https://github.com/rivenmedia/riven/commit/f91ffece2a70af71967903847068642e58a4f51c)) +* Adds default value for API_KEY. ([bc6ff28](https://github.com/rivenmedia/riven/commit/bc6ff28ff5b1d1632f2dd2ca64743c4012ccc396)) +* Adds python-dotenv to load .env variables. ([65a4aec](https://github.com/rivenmedia/riven/commit/65a4aec275a1f7768a77ef0227d6fb402f9a8612)) +* Corrects type hint for incomplete_retries in StatsResponse. ([#839](https://github.com/rivenmedia/riven/issues/839)) ([f91ffec](https://github.com/rivenmedia/riven/commit/f91ffece2a70af71967903847068642e58a4f51c))
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
CHANGELOG.md
(1 hunks)pyproject.toml
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pyproject.toml
🔇 Additional comments (1)
CHANGELOG.md (1)
3-4
: LGTM!
The version header follows semantic versioning format and includes the correct GitHub compare URL.
4c436cc
to
39f916e
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)
6-16
: Consider improving feature descriptions and fixing typo.While the features section is well-structured with proper links and commit hashes, consider:
- Making some feature titles more descriptive:
- "requests second pass" could better explain the changes
- Fixing the typo:
- "we now server sse" should be "we now serve SSE"
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
CHANGELOG.md
(1 hunks)pyproject.toml
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pyproject.toml
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (2)
CHANGELOG.md (2)
3-5
: LGTM! Version header follows best practices.
The version header is well-formatted with:
- Semantic version number (0.17.0)
- GitHub compare link
- ISO date format
19-36
: LGTM! Bug fixes are well-documented.
The bug fixes section is comprehensive and follows best practices:
- Clear descriptions of the resolved issues
- Proper linking to GitHub issues and commits
- Good organization of the fixes
39f916e
to
10dbc83
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
CHANGELOG.md (1)
6-17
: Consider hyphenating the compound adjective.The features are well-documented with proper references. However, consider hyphenating "rate limiting" to "rate-limiting" in the feature description as it's used as a compound adjective.
Apply this diff:
-* add rate limiting tests and update dependencies ([#857](https://github.com/rivenmedia/riven/issues/857)) ([27c8534](https://github.com/rivenmedia/riven/commit/27c8534f3084404f80e6bf8fc01b1be0b9d98ad8)) +* add rate-limiting tests and update dependencies ([#857](https://github.com/rivenmedia/riven/issues/857)) ([27c8534](https://github.com/rivenmedia/riven/commit/27c8534f3084404f80e6bf8fc01b1be0b9d98ad8))🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
CHANGELOG.md
(1 hunks)pyproject.toml
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pyproject.toml
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (2)
CHANGELOG.md (2)
3-5
: LGTM!
The version header follows the standard changelog format with proper version number, GitHub comparison link, and release date.
20-37
: LGTM!
The bug fixes are well-documented with proper references and clear descriptions.
10dbc83
to
4901381
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
CHANGELOG.md (2)
10-10
: Consider adding a hyphen for consistency.The entry "add rate limiting tests" should use a hyphen for the compound adjective.
-* add rate limiting tests and update dependencies ([#857](https://github.com/rivenmedia/riven/issues/857)) ([27c8534](https://github.com/rivenmedia/riven/commit/27c8534f3084404f80e6bf8fc01b1be0b9d98ad8)) +* add rate-limiting tests and update dependencies ([#857](https://github.com/rivenmedia/riven/issues/857)) ([27c8534](https://github.com/rivenmedia/riven/commit/27c8534f3084404f80e6bf8fc01b1be0b9d98ad8))🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
17-18
: Consider adding more context to the stream endpoint entry.The entry about Server-Sent Events (SSE) could benefit from additional context about its purpose and benefits.
-* we now server sse via /stream ([efbc471](https://github.com/rivenmedia/riven/commit/efbc471e4f4429c098df2a601b3f3c42b98afbb7)) +* we now serve Server-Sent Events (SSE) via /stream endpoint for real-time updates ([efbc471](https://github.com/rivenmedia/riven/commit/efbc471e4f4429c098df2a601b3f3c42b98afbb7))
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
CHANGELOG.md
(1 hunks)pyproject.toml
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pyproject.toml
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (1)
CHANGELOG.md (1)
3-39
: LGTM! The changelog is well-structured and informative.
The changelog follows proper conventions with:
- Clear semantic versioning
- Proper categorization of changes
- Consistent linking to issues and commits
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
4901381
to
b0cd0ba
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
CHANGELOG.md (2)
6-18
: Consider adding more context to feature descriptions.While the feature entries are well-formatted and include proper references, some entries could benefit from additional context about their impact:
- "bearer authentication" - Consider mentioning the security benefits or changes required by users
- "filesize filter" - Consider specifying the supported size ranges or use cases
- "stream management endpoints" - Consider listing the key endpoints added
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...(EN_COMPOUND_ADJECTIVE_INTERNAL)
21-39
: Maintain consistency in commit message style.While most bug fix entries start with a verb in present tense (e.g., "add", "correct", "ensure"), some entries use past tense or different formats:
- "jackett again - my bad" could be more descriptive
- "MediaFusion scraper." could specify what was fixed
- "files sometimes not found in mount" could start with a verb
Consider standardizing all commit messages to use present tense and be more descriptive.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
CHANGELOG.md
(1 hunks)pyproject.toml
(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pyproject.toml
🧰 Additional context used
🪛 LanguageTool
CHANGELOG.md
[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...9e8d6d841ab625284c54d78b9dc02d1)) * add rate limiting tests and update dependencies ([#857](h...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🔇 Additional comments (1)
CHANGELOG.md (1)
3-5
: LGTM! Header follows standard changelog format.
The release header is well-structured with version, date, and compare link.
🤖 Created releases:
|
🤖 I have created a release beep boop
0.17.0 (2024-11-05)
Features
Bug Fixes
This PR was generated with Release Please. See documentation.
Summary by CodeRabbit
Release Notes for Version 0.17.0
New Features
/stream
.Bug Fixes
These updates enhance user experience and system reliability.