[OSDEV-1785] Link to the forked aiokafka@0.8.0#534
Conversation
📝 WalkthroughWalkthroughThis pull request updates the release documentation and Docker build process. The release notes and protocol files have been modified to shift the versioning from 2.x to 1.30.0, update release dates, remove redundant sections and legacy version entries, and streamline content. The Dockerfile now removes the Changes
Sequence Diagram(s)sequenceDiagram
participant Build as Docker Build Process
participant Req as requirements.txt
participant Git as Git Repository
Build->>Req: Read requirements.txt
Build->>Req: Execute sed to remove aiokafka
Build->>Build: Install dependencies from modified requirements.txt
Build->>Git: Clone and install aiokafka from the custom repository
Git-->>Build: Provide the specified aiokafka package
Build->>Build: Cleanup by removing requirements.txt
Possibly related PRs
Suggested reviewers
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.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/django/Dockerfile (1)
7-10: Removing aiokafka from RequirementsThe addition of the comment and the sed command (
+# [OSDEV-1785][https://github.com/aio-libs/aiokafka/issues/1093] - Remove aiokafka in requirements.txt to avoid conflicts. +RUN sed -i '/aiokafka/d' requirements.txt) clearly documents why aiokafka is removed from requirements.txt to prevent conflicts.
Consider verifying that the regex exactly matches the intended package name in all cases, though this simple pattern should work in most scenarios.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
doc/release/RELEASE-NOTES.md(3 hunks)doc/release/RELEASE-PROTOCOL.md(1 hunks)src/django/Dockerfile(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
- GitHub Check: run-integration-test-code-quality
- GitHub Check: run-flake8-linter
- GitHub Check: run-fe-code-quality
- GitHub Check: run-eslint-linter-and-prettier-formatter
- GitHub Check: run-django-code-quality
- GitHub Check: run-dd-code-quality
- GitHub Check: run-countries-code-quality
- GitHub Check: run-contricleaner-code-quality
- GitHub Check: get-base-branch-fe-cov
- GitHub Check: get-base-branch-countries-cov
- GitHub Check: get-base-branch-django-cov
- GitHub Check: get-base-branch-contricleaner-cov
- GitHub Check: get-base-branch-dd-cov
🔇 Additional comments (3)
doc/release/RELEASE-PROTOCOL.md (1)
56-56: Version Table Update: New Release Entry for v1.30.0The new row
| v1.30.0 | March 1, 2025 | February 25, 2025 | @Vadim Kovalenko |appears to correctly replace the removed v2.0.0 and v2.1.0 entries, reflecting the new minor versioning strategy. Please double-check that all related documentation (especially RELEASE-NOTES.md) matches this change.
src/django/Dockerfile (1)
24-25: Installing aiokafka from the Custom RepositoryThe custom pip install command:
+# [OSDEV-1785][https://github.com/aio-libs/aiokafka/issues/1093] - Install aiokafka from the custom repo. +&& pip install --no-cache-dir git+https://github.com/VadimKovalenkoSNF/aiokafka.git@kafka-python-2.0.3 \ensures that the forked version of aiokafka is installed from the specified Git repository at the desired branch or tag. Please confirm that the branch/tag “kafka-python-2.0.3” is maintained as expected and integrates well with the rest of the dependencies.
doc/release/RELEASE-NOTES.md (1)
6-11: Updated Release Notes for Version 1.30.0The release notes now reflect the new release version and corresponding release date:
## Release 1.30.0 ... * Release date: March 01, 2025This update is consistent with the changes made in the release protocol and supports the new versioning strategy. Everything looks clear and consistent.
React App | Jest test suite - Code coverage reportTotal: 29.56%Your code coverage diff: 0.00% ▴ ✅ All code changes are covered |
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
doc/release/RELEASE-NOTES.md (1)
52-52: Default Search Tab Update (OSDEV-1745)
The release note for OSDEV-1745 now indicates that the "Search by Name and Address" tab is set as the default on the Production Location Search page. It would be helpful to include a brief description of why this change was made (for example, improvements in usability or addressing specific user feedback) to provide better context for the change.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
doc/release/RELEASE-NOTES.md(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (13)
- GitHub Check: run-integration-test-code-quality
- GitHub Check: run-flake8-linter
- GitHub Check: run-fe-code-quality
- GitHub Check: run-eslint-linter-and-prettier-formatter
- GitHub Check: run-django-code-quality
- GitHub Check: run-dd-code-quality
- GitHub Check: run-countries-code-quality
- GitHub Check: run-contricleaner-code-quality
- GitHub Check: get-base-branch-fe-cov
- GitHub Check: get-base-branch-dd-cov
- GitHub Check: get-base-branch-countries-cov
- GitHub Check: get-base-branch-contricleaner-cov
- GitHub Check: get-base-branch-django-cov
🔇 Additional comments (4)
doc/release/RELEASE-NOTES.md (4)
6-6: Release Version Update via Header
The header now reads "## Release 1.30.0", which updates the release version as intended. Please verify that this version change is consistent across all release documentation and deployment pipelines.
10-10: Updated Release Date
The release date has been changed to "March 01, 2025". Ensure that this date accurately reflects the planned release schedule and is consistent with any related documentation (e.g., RELEASE-PROTOCOL.md).
34-34: Architecture Diagram Update Description (OSDEV-1580)
The note for OSDEV-1580 now specifies that the new architecture diagram has been placed in the root of the./doc/system_design/folder with the old ones archived, and that a newREADME.mdhas been created. Please double-check that the file paths and descriptions match the actual file structure and that the testing timeline (pen testing in February 2025) is still valid.
35-35: aiokafka Fork Information (OSDEV-1785)
The release notes now document that the aiokafka repository has been forked, reverted to v0.8.0, and that a dedicated branch (kafka-python-2.0.3) has been created with thekafka-pythonversion pinned to v2.0.3. This change directly addresses the PR objective. Please confirm that these details (branch name, version numbers, and reference links) are consistent with the Dockerfile and other release artifacts.
Fix [OSDEV-1785](https://opensupplyhub.atlassian.net/browse/OSDEV-1785) Link to the forked aiokafka@0.8.0 Workaround for issue mentioned in aio-libs/aiokafka#1093




Fix OSDEV-1785
Link to the forked aiokafka@0.8.0
Workaround for issue mentioned in aio-libs/aiokafka#1093