docs: surface dual-loader support (envconfig + env-tag) on framework pages#88
Conversation
…pages The framework Config struct carries both envconfig: and env: struct tags on every field, but the docs only mentioned envconfig — hiding the interop story from users of caarlos0/env, sethvargo/go-envconfig, ilyakaznacheev/cleanenv, and similar env:-tag loaders. - config-reference.md: full dual-loader phrasing with three loader examples - Packages.md, FAQ.md, architecture.md: shorter mention of compatible env:-tag loaders alongside envconfig - howto/APIs.md: drop orphaned [envconfig] reference link def (no body usage) Howto pages that show users adding fields to their own AppConfig (database/cache/messaging) are intentionally untouched — those examples should still use a single tag matching whichever loader the user chooses.
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ 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. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Review rate limit: 0/1 reviews remaining, refill in 59 minutes and 2 seconds.Comment |
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to explicitly describe that the framework Config struct supports both envconfig:"…" and env:"…" struct tags, clarifying that ColdBrew configuration can be loaded via kelseyhightower/envconfig (cookiecutter default) or other env:-tag loaders.
Changes:
- Expanded
/config-referenceto describe dual-tag support and provide multiple loader examples. - Added shorter dual-loader mentions to
Packages,FAQ, andArchitecture. - Removed an unused/orphaned
[envconfig]link definition fromhowto/APIs.md(confirmed no remainingenvconfigreferences in that file).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| Packages.md | Notes dual-tag support for the core config package and links to an env:-tag loader example. |
| config-reference.md | Adds full dual-loader explanation with multiple compatible loader links. |
| FAQ.md | Updates the Kubernetes-native feature list to mention env:-tag loader compatibility. |
| architecture.md | Updates the 12-factor “Config” row to include env:-tag loader compatibility. |
| howto/APIs.md | Removes an unused [envconfig] link definition (no in-file references remain). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Summary
The framework
Configstruct carries bothenvconfig:"…"andenv:"…"struct tags on every field, but the docs only mentioned envconfig — hiding the interop story from users ofcaarlos0/env,sethvargo/go-envconfig,ilyakaznacheev/cleanenv, and similarenv:-tag loaders.config-reference.md: full dual-loader phrasing with three loader examplesPackages.md,FAQ.md,architecture.md: shorter mention of compatibleenv:-tag loaders alongside envconfighowto/APIs.md: drop orphaned[envconfig]reference link def (no body usage)Howto pages that show users adding fields to their own
AppConfig(database, cache, messaging) are intentionally untouched — those examples should still use a single tag matching whichever loader the user chooses.Pairs with go-coldbrew/core#89, which adds the same note to the
Configtype doc comment.Test plan
bundle exec jekyll serve) and confirm the four pages render:/config-reference,/Packages,/FAQ,/architecturecaarlos0/envlinks resolvehowto/APIs.mdstill renders without the removed link def