docs: move go version guidance to compatibility sections#1435
Conversation
ReneWerner87
requested review from
efectn,
gaby and
sixcolors
and removed request for
a team
github-actions
Bot
added
the
📒 Documentation
|
Warning Rate limit exceeded@ReneWerner87 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 31 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (19)
📒 Files selected for processing (16)
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughDocumentation updates across 20+ middleware and service READMEs to add "Go version support" sections indicating support for the latest two Go versions, normalize middleware names to lowercase in the main README, reorganize installation sections, and in one case document public API signatures. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary of ChangesHello @ReneWerner87, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation across the repository by standardizing the presentation of Go version compatibility. It ensures that all Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request does a good job of centralizing the Go version support policy across the various README files. My review focuses on ensuring consistency and clarity. I've pointed out several instances where the newly added general policy conflicts with older, specific version requirements (e.g., 'Requires Go 1.25'), which could confuse users. I've also noted a minor capitalization inconsistency in the main README.md. Addressing these points will improve the overall quality of the documentation.
![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
🧹 Nitpick comments (8)
v3/otel/example/README.md (1)
14-20: Go version support section added; consider reformatting emphasis as headings.The additions clearly establish Go version requirements and support policy. However, markdownlint (MD036) flagged lines 14–16 for using emphasis (
**text**) instead of markdown headings. While this formatting is consistent with other READMEs in the codebase, consider using proper heading syntax for improved documentation consistency if the linter is enforced in CI.v3/otel/README.md (1)
15-21: Clarify Go version requirements—potential misalignment.Line 15 states "Requires Go 1.25 and above" while the new section (lines 19-21) indicates support for "the latest two versions of Go." These statements may conflict: the latest two Go versions would currently be 1.24 and 1.25, making the 1.25+ requirement more restrictive than "latest two" implies.
Consider aligning the "Requires Go 1.25" note with the actual version support policy or updating it to reflect the latest two versions accurately.
v3/loadshed/README.md (1)
13-13: Clarify Go version requirements—consistent with otel file.Similar to v3/otel/README.md, line 13's "Requires Go 1.25 and above" may conflict with the new "latest two versions" statement. Consider aligning these across all modules to avoid user confusion.
Also applies to: 17-19
v3/swagger/README.md (1)
14-14: Clarify Go version requirements.Similar to other modules, line 14's "Note: Requires Go 1.25 and above" may create ambiguity alongside the new "latest two versions of Go" statement.
Also applies to: 18-20
v3/paseto/README.md (1)
17-17: Clarify Go version requirements.Line 17's "Requires Go 1.25 and above" should be aligned with the new "latest two versions" policy documented in lines 21–23. Consider standardizing version language across all modules to avoid user confusion.
Also applies to: 21-23
v3/casbin/README.md (1)
15-15: Clarify Go version requirements.Align line 15's "Requires Go 1.25 and above" with the "latest two versions" policy in lines 17–19 for consistency across modules.
Also applies to: 17-19
v3/zerolog/README.md (1)
13-13: Clarify Go version requirements.Line 13's "Requires Go 1.25 and above" should be aligned with the "latest two versions" policy in lines 17–19 for consistency across modules.
Also applies to: 17-19
v3/sentry/README.md (1)
13-13: Clarify Go version requirements.Line 13's "Requires Go 1.25 and above" should be aligned with the "latest two versions" policy in lines 17–19 for consistency with all other modules in this PR.
Also applies to: 17-19
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (21)
README.md(1 hunks)v3/casbin/README.md(1 hunks)v3/circuitbreaker/README.md(2 hunks)v3/fgprof/README.md(1 hunks)v3/hcaptcha/README.md(1 hunks)v3/i18n/README.md(1 hunks)v3/jwt/README.md(1 hunks)v3/loadshed/README.md(1 hunks)v3/monitor/README.md(1 hunks)v3/newrelic/README.md(1 hunks)v3/opa/README.md(1 hunks)v3/otel/README.md(1 hunks)v3/otel/example/README.md(2 hunks)v3/paseto/README.md(1 hunks)v3/sentry/README.md(1 hunks)v3/socketio/README.md(1 hunks)v3/swagger/README.md(1 hunks)v3/testcontainers/README.md(1 hunks)v3/websocket/README.md(1 hunks)v3/zap/README.md(1 hunks)v3/zerolog/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (15)
📓 Common learnings
Learnt from: ReneWerner87
PR: gofiber/recipes#0
File: :0-0
Timestamp: 2024-11-26T20:05:15.793Z
Learning: For future contributions to the `gofiber/recipes` repository, ensure that the tasks outlined in `.github/CONTRIBUTING.md` are incorporated, including creating a new directory without a "fiber" prefix, adding a `README.md` with Docusaurus metadata, and updating the overview by running `make generate`.
📚 Learning: 2025-02-12T11:24:31.153Z
Learnt from: ReneWerner87
PR: gofiber/storage#0
File: :0-0
Timestamp: 2025-02-12T11:24:31.153Z
Learning: The storage package in gofiber/storage repository can be used independently of the Fiber web framework.
Applied to files:
v3/loadshed/README.mdv3/testcontainers/README.mdv3/jwt/README.mdv3/paseto/README.mdREADME.mdv3/i18n/README.mdv3/swagger/README.md
📚 Learning: 2024-11-15T07:56:21.623Z
Learnt from: ReneWerner87
PR: gofiber/fiber#3161
File: app.go:923-932
Timestamp: 2024-11-15T07:56:21.623Z
Learning: In the Fiber framework, breaking changes are acceptable when moving from version 2 to version 3, including modifications to method signatures such as in the `Test` method in `app.go`.
Applied to files:
v3/loadshed/README.mdv3/websocket/README.mdv3/testcontainers/README.mdv3/zap/README.mdv3/jwt/README.mdv3/paseto/README.mdv3/zerolog/README.mdv3/circuitbreaker/README.mdv3/newrelic/README.mdREADME.mdv3/i18n/README.mdv3/socketio/README.mdv3/opa/README.mdv3/hcaptcha/README.mdv3/fgprof/README.mdv3/swagger/README.mdv3/otel/README.mdv3/casbin/README.mdv3/monitor/README.md
📚 Learning: 2025-10-16T07:15:26.529Z
Learnt from: grivera64
PR: gofiber/fiber#3807
File: adapter_test.go:118-144
Timestamp: 2025-10-16T07:15:26.529Z
Learning: In Fiber v3, net/http handlers (http.Handler, http.HandlerFunc, or raw func(http.ResponseWriter, *http.Request)) can be passed directly to routing methods like app.Get(), app.Post(), etc. The framework automatically detects and wraps them internally via toFiberHandler/collectHandlers. The github.com/gofiber/fiber/v3/middleware/adaptor package is legacy and should not be suggested for tests or code using native net/http handler support.
Applied to files:
v3/websocket/README.mdv3/newrelic/README.md
📚 Learning: 2024-11-23T19:50:41.765Z
Learnt from: norri
PR: gofiber/recipes#2701
File: clean-code/app/server/server.go:14-16
Timestamp: 2024-11-23T19:50:41.765Z
Learning: In the `clean-code` example at `clean-code/app/server/server.go` using the Go Fiber framework, it's acceptable to omit production-level features like context usage and graceful shutdown handling to keep the example simple.
Applied to files:
v3/testcontainers/README.mdREADME.mdv3/otel/example/README.mdv3/swagger/README.md
📚 Learning: 2025-05-08T08:14:37.302Z
Learnt from: mdelapenya
PR: gofiber/fiber#3434
File: app.go:623-636
Timestamp: 2025-05-08T08:14:37.302Z
Learning: In the gofiber/fiber framework, service startup failures should panic rather than allowing the application to continue running with degraded functionality, as this is the agreed-upon design decision.
Applied to files:
v3/circuitbreaker/README.md
📚 Learning: 2024-09-25T16:18:34.719Z
Learnt from: sixcolors
PR: gofiber/fiber#3016
File: middleware/session/config.go:122-122
Timestamp: 2024-09-25T16:18:34.719Z
Learning: In `DefaultErrorHandler(c *fiber.Ctx, err error)`, since `c` is a pointer to an interface, we need to dereference `*c` when calling interface methods like `SendStatus`.
Applied to files:
v3/newrelic/README.md
📚 Learning: 2025-10-16T07:19:52.418Z
Learnt from: grivera64
PR: gofiber/fiber#3807
File: adapter_test.go:118-144
Timestamp: 2025-10-16T07:19:52.418Z
Learning: In the Fiber codebase, the linter does not allow `require` assertions from within HTTP handlers (including net/http-style handlers). Use `t.Fatalf`, `t.Errorf`, or similar `testing.T` methods for error handling inside handler functions instead.
Applied to files:
v3/newrelic/README.md
📚 Learning: 2025-02-07T10:18:09.439Z
Learnt from: SadikSunbul
PR: gofiber/recipes#2797
File: email-verification/main.go:26-31
Timestamp: 2025-02-07T10:18:09.439Z
Learning: In the gofiber/recipes repository, recipes should focus on demonstrating specific features clearly without production-level configurations like advanced error handling, graceful shutdown, or security middleware, as they are meant to be educational examples.
Applied to files:
README.md
📚 Learning: 2024-07-03T11:59:00.303Z
Learnt from: ReneWerner87
PR: gofiber/contrib#0
File: :0-0
Timestamp: 2024-07-03T11:59:00.303Z
Learning: The i18n functionality in the gofiber/contrib repository is being refactored from middleware to a global container to improve robustness and performance. The global container will be initialized once before setting up routes and will manage the i18n bundle and localizer map.
Applied to files:
README.mdv3/i18n/README.md
📚 Learning: 2025-02-07T10:16:46.994Z
Learnt from: SadikSunbul
PR: gofiber/recipes#2797
File: email-verification/infrastructure/email/smtp.go:22-22
Timestamp: 2025-02-07T10:16:46.994Z
Learning: In the gofiber/recipes repository, which contains example implementations and recipes, it's acceptable to have credentials directly in the code for demonstration purposes since these are meant to be educational examples rather than production code.
Applied to files:
README.md
📚 Learning: 2025-05-14T01:04:10.042Z
Learnt from: itssimon
PR: gofiber/recipes#3108
File: monitoring-with-apitally/main.go:90-105
Timestamp: 2025-05-14T01:04:10.042Z
Learning: In recipe examples for the gofiber/recipes repository, it's acceptable to have placeholder comments for business logic (like data storage) when the primary focus is on demonstrating a specific integration or feature (such as Apitally monitoring).
Applied to files:
README.md
📚 Learning: 2024-11-26T20:05:15.793Z
Learnt from: ReneWerner87
PR: gofiber/recipes#0
File: :0-0
Timestamp: 2024-11-26T20:05:15.793Z
Learning: For future contributions to the `gofiber/recipes` repository, ensure that the tasks outlined in `.github/CONTRIBUTING.md` are incorporated, including creating a new directory without a "fiber" prefix, adding a `README.md` with Docusaurus metadata, and updating the overview by running `make generate`.
Applied to files:
v3/otel/example/README.md
📚 Learning: 2024-11-23T19:35:36.767Z
Learnt from: norri
PR: gofiber/recipes#2701
File: clean-code/app/main.go:0-0
Timestamp: 2024-11-23T19:35:36.767Z
Learning: In the Go `clean-code` example (`clean-code/app/main.go`) in the `gofiber/recipes` repository, it's acceptable to omit graceful shutdown handling, as the example code prioritizes simplicity over production-level practices.
Applied to files:
v3/otel/example/README.md
📚 Learning: 2024-11-23T19:34:59.534Z
Learnt from: norri
PR: gofiber/recipes#2701
File: clean-code/app/main.go:0-0
Timestamp: 2024-11-23T19:34:59.534Z
Learning: In this codebase, `NewConfiguration()` reads environment variables with defaults and cannot fail, so error handling for it is unnecessary.
Applied to files:
v3/monitor/README.md
🪛 markdownlint-cli2 (0.18.1)
v3/otel/example/README.md
14-14: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (26)
v3/opa/README.md (1)
17-19: Go version support section added correctly.The new section clearly communicates the Go version policy and provides a link to official documentation. Positioning before the Install section is appropriate.
v3/socketio/README.md (1)
17-19: Go version support section added correctly.Consistent with other module READMEs. Placement before Install section aligns with the PR's standardization effort.
v3/testcontainers/README.md (1)
21-23: Go version support section appropriately placed.Positioned after the Requires note but before Common Use Cases section. Consistent with the overall PR standardization.
v3/hcaptcha/README.md (1)
21-23: Go version support section added correctly.Positioned between the :::caution note block and Install section. Maintains consistency with other v3 module READMEs.
v3/newrelic/README.md (1)
17-19: Go version support section added as intended.Clear communication of the latest two Go versions policy with reference to official documentation. Placement is consistent with the PR's standardization across all v3 modules.
v3/websocket/README.md (1)
17-19: Go version support section properly integrated.Positioned after the Fiber v3 compatibility note and before the Install section. Consistent with all other v3 module READMEs in this PR.
v3/i18n/README.md (1)
17-20: Go version support section added with proper spacing.The section is well-positioned after the compatibility note, with the blank line on line 20 providing appropriate visual separation before the Install section. Consistent with the PR's standardization effort.
v3/circuitbreaker/README.md (1)
15-17: Documentation section added—looks good.The new Go version support section is properly placed and consistent with the broader PR updates across modules.
v3/swagger/README.md (1)
16-20: Inconsistency between code display and AI summary.The AI summary states "Removed the duplicated trailing 'Compatible with Fiber v3.' block at the end of the file," but the code clearly shows "Compatible with Fiber v3" still present at lines 16–17.
Please verify: (1) Are there two instances of "Compatible with Fiber v3" in this file—one that was kept and one that was removed? (2) Or has the summary incorrectly characterized the changes?
v3/paseto/README.md (1)
25-31: Comprehensive install instructions—well done.The expanded Install section now includes the required
o1egl/pasetodependency alongside the Fiber packages, providing users with complete installation guidance in a single command block. This is better than requiring users to hunt for the dependency.v3/casbin/README.md (1)
17-19: Documentation section added—appropriate pattern.The Go version support section is properly placed, and the module's Install section correctly handles adapter dependencies as optional add-ons below the main installation block.
v3/zerolog/README.md (1)
21-26: Comprehensive install instructions—consistent with best practices.The expanded Install section now includes the required
rs/zerologpackage (line 26), providing complete setup instructions. This mirrors the approach in paseto and sentry, which is the right pattern for required dependencies.v3/sentry/README.md (1)
21-26: Comprehensive install instructions—properly aligned with related modules.The expanded Install section now includes the required
getsentry/sentry-gopackage (line 26), matching the pattern established in paseto and zerolog. Complete and user-friendly.README.md (2)
16-16: LGTM on Go version support note placement and content.The Go version support note provides clear guidance with a proper reference link. The blockquote formatting appropriately highlights this important requirement at the top of the repository.
22-39: Middleware naming normalization is consistent and comprehensive.All middleware names have been normalized to lowercase following a clear convention (e.g.,
casbin,circuitbreaker,new relic,open policy agent,otel (opentelemetry),socket.io,websocket). The list links and workflow status badge references align with the normalized names.v3/jwt/README.md (3)
18-24: Verify consistency of version/compatibility statements.The file now has three separate version-related statements:
- Line 18: "Note: Requires Go 1.25 and above"
- Line 20: "Compatible with Fiber v3."
- Lines 22–24: New "Go version support" section
The AI summary indicates line 20 ("Compatible with Fiber v3.") should be removed, but it remains in the code. Consider whether all three statements are necessary, or if the new "Go version support" section should replace the inline compatibility note to reduce redundancy.
22-24: Go version support section text is consistent across modules.The wording and link format match the corresponding sections in other module READMEs, ensuring uniform guidance throughout the repository.
26-32: Install section extended with JWT library dependency.The addition of
go get -u github.com/golang-jwt/jwt/v5(line 31) is appropriate and completes the dependency chain for the JWT middleware. The section now documents all required packages.v3/zap/README.md (2)
17-19: Go version support section is consistent with other modules.Identical wording and link format as other README files ensure uniform documentation across the repository.
21-27: Install section properly extended with Uber Zap dependency.The addition of
go get -u go.uber.org/zap(line 26) ensures users install all required dependencies for the logging middleware to function correctly.v3/fgprof/README.md (2)
17-19: Go version support section follows the established pattern.Text and link are consistent with other module READMEs. Placement before the Install section is appropriate and aligns with the PR's documentation reorganization goal.
21-28: Install section clearly documents dependencies.The section provides standard
go getcommands for the Fiber framework and fgprof middleware. The structure is consistent with other module documentation updates.v3/monitor/README.md (4)
17-19: Go version support section is consistent with all other modules.The section follows the established pattern across the repository and provides clear, actionable guidance.
28-32: Signature documentation added, but verify against source code.The new Signature section documents the public API:
monitor.New(config ...monitor.Config) fiber.Handler. This follows the standard Fiber middleware pattern and is consistent with other middleware documentation in the repository.Please verify that this signature matches the actual implementation in the monitor package source code.
34-44: Config section documentation appears complete, but review property descriptions.The Config table documents all expected properties with types, descriptions, and defaults. However, line 41 contains a potentially incorrect description for the
Nextproperty—it reads "Define a function to add custom fields," but the typefunc(c fiber.Ctx) booland common Fiber patterns suggest this should define middleware skip behavior, not add fields. This description appears to be copied from aFieldsFuncproperty.Please verify the actual Config struct definition and correct the
Nextproperty description if necessary.
21-26: Install section is complete and properly formatted.The section includes both the Fiber v3 and contrib/v3/monitor dependencies, providing users with all required packages.
1 participant
Summary
Testing
https://chatgpt.com/codex/tasks/task_e_69033a5d869483268eff4976c180b75b
Summary by CodeRabbit