-
Notifications
You must be signed in to change notification settings - Fork 212
chore(docs): PR 1.6 add documentation and linting configuration for v3 #361
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
Open
developerkunal
wants to merge
6
commits into
v3-phase1-pr5-middleware-options
Choose a base branch
from
v3-phase1-pr6-documentation-linting
base: v3-phase1-pr5-middleware-options
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
chore(docs): PR 1.6 add documentation and linting configuration for v3 #361
developerkunal
wants to merge
6
commits into
v3-phase1-pr5-middleware-options
from
v3-phase1-pr6-documentation-linting
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add doc.go files for all packages (main, core, validator, jwks, oidc) - Update README.md for v3 API with working JWT examples - Update MIGRATION_GUIDE.md with complete v2 to v3 guide - Remove CVE-2025-27144 mitigation (handled by jwx v3) - Configure golangci-lint v2.6.2 with proper test exclusions - Fix JWT token configuration to match working examples - Update Go version requirement to 1.24+ - Fix import paths (github.com/auth0/go-jwt-middleware/v3) - Clarify GetClaims[T]() is required (ContextKey no longer exported) - Update GitHub Actions to use golangci-lint v2.6.2 - Update Makefile with lint installation Coverage: 99.4% (98.2% main, 100% core/validator/jwks/oidc) Linting: 0 issues
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## v3-phase1-pr5-middleware-options #361 +/- ##
====================================================================
- Coverage 98.88% 98.86% -0.02%
====================================================================
Files 13 12 -1
Lines 718 707 -11
====================================================================
- Hits 710 699 -11
Misses 4 4
Partials 4 4 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
- Change version to string format ("2" not 2)
- Move linter settings from top-level to linters.settings
- Move exclusions to linters.exclusions with new structure
- Remove unsupported output fields
- Update exclusions format (presets, paths, rules)
Verified with: golangci-lint config verify
…cumentation-linting
…cumentation-linting
…lidateToken - Update doc.go with all examples using WithValidator - Update README.md examples throughout - Update MIGRATION_GUIDE.md with correct v3 API - Update option.go comment example - Align all documentation with the new API that accepts *validator.Validator instances All documentation now correctly shows the v3 API where middleware accepts validator instances via WithValidator, enabling future extensibility for methods like ValidateDPoP.
…cumentation-linting
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Checklist
🔧 Changes
This PR adds comprehensive documentation and linting configuration for v3:
Documentation Added:
doc.gopackage documentation for all packages:core/doc.go: Core-Adapter pattern, context helpersvalidator/doc.go: JWT validation with jwx v3, supported algorithmsjwks/doc.go: JWKS provider configuration and cachinginternal/oidc/doc.go: OIDC discovery endpointsDocumentation Updated:
README.md: Complete v3 API documentationMIGRATION_GUIDE.md: Complete v2 to v3 migration guideLinting Configuration:
.golangci.yml: golangci-lint v2.6.2 configuration.github/workflows/lint.yaml: Updated to use golangci-lint-action v9.1.0 with v2.6.2Makefile: Added golangci-lint v2.6.2 installation targetCode Cleanup:
validator/security.goandvalidator/security_test.goTypes/Functions Changed:
📚 References
🔬 Testing
Test Coverage:
Linting:
Manual Testing:
Verification: