Release v3.0 #480
Release v3.0 #480
Conversation
dosubot
bot
added
the
size:S
WalkthroughThe changes in this pull request involve modifications to three files: Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
composer.json (1)
58-65: Consider documenting upgrade steps for consumers.Since this is a major release moving from RC to stable, consider documenting any breaking changes or upgrade steps required for consumers of these packages.
Would you like me to help create an upgrade guide or release notes document?
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (3)
.gitignore(1 hunks)composer.json(1 hunks)storage/swagger/http.json(0 hunks)
💤 Files with no reviewable changes (1)
- storage/swagger/http.json
✅ Files skipped from review due to trivial changes (1)
- .gitignore
🔇 Additional comments (2)
composer.json (2)
58-65: Version constraints updated consistently for release.
All mineadmin package versions have been consistently updated from "3.0-RC" to "3.0", which aligns with the release objectives.
Let's verify there are no remaining RC references in the codebase:
✅ Verification successful
Version upgrade to 3.0 verified successfully
The codebase has been thoroughly checked and all mineadmin package versions have been consistently updated to "3.0". No remaining references to "3.0-RC" were found. The only other version references found are for php-cs-fixer (^3.0) and a development branch alias (3.0-dev), which are both correct and unrelated to the RC upgrade.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Check for any remaining RC version references
# Expected: No occurrences of "3.0-RC" should be found
rg -i "3\.0-RC" --type-add 'config:*.{json,yaml,yml,php}' -t config
Length of output: 69
Script:
#!/bin/bash
# Let's try a broader search for any RC references in all files
rg -i "3\.0-rc"
# Also search for version-related patterns in composer files
rg -i "version|3\.0" composer.*
Length of output: 383
58-65: Verify API documentation availability after swagger file removal.
The removal of storage/swagger/http.json could impact API documentation. Since the project depends on zircote/swagger-php, ensure that:
- The OpenAPI specification can still be generated
- API documentation remains accessible to consumers
Let's check for alternative swagger configuration or documentation:
✅ Verification successful
API documentation generation is properly configured and functional
The swagger configuration is intact and well-configured:
- Auto-generation is enabled (
auto_generate => true) - Documentation is scanned from
/app/Httpand/app/Schemadirectories - OpenAPI 3.0 specifications are defined in
Server.php - The removed
storage/swagger/http.jsonfile is auto-generated in the configured output directory (json_dir => BASE_PATH . '/storage/swagger')
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Look for swagger/OpenAPI related files
# Expected: Find alternative swagger configuration or documentation files
# Search for swagger config files
fd -e php -e yaml -e json . | rg -i "swagger|openapi"
# Search for swagger annotations in code
rg -l "@OA|@OpenAPI" -t php
Length of output: 148
Script:
#!/bin/bash
# Let's examine the swagger configuration and server files
cat config/autoload/swagger.php
echo "---"
cat app/Http/Common/Swagger/Server.php
# Let's also check for any API controller files that might contain swagger annotations
fd -e php . | rg -i "controller" | xargs rg -l "@OA|@SWG|@Swagger"
Length of output: 2299
Summary by CodeRabbit
.gitignorefile to include*.lockandstorage/swagger/http.json."friendsofhyperf/tinker": "^3.1", incomposer.json.composer.jsonfrom "3.0-RC" to "3.0" for variousmineadminpackages.storage/swagger/http.jsonfile, which contained the OpenAPI specification for the API.