add a migration guide #99
Merged
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
grounded042
commented
Jul 16, 2021
Comment on lines
-78
to
-87
| // WithValidateToken sets up the function to be used to validate all tokens. | ||
| // See the ValidateToken type for more information. | ||
| // Default: TODO: after merge into `v2` | ||
| func WithValidateToken(vt ValidateToken) Option { | ||
| return func(m *JWTMiddleware) { | ||
| m.validateToken = vt | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
This isn't needed as the first parameter to New is ValidateToken.
Codecov Report
@@ Coverage Diff @@
## v2 #99 +/- ##
=====================================
Coverage ? 86.51%
=====================================
Files ? 3
Lines ? 178
Branches ? 0
=====================================
Hits ? 154
Misses ? 19
Partials ? 5 Continue to review full report at Codecov.
|
Signed-off-by: Jon Carl <[email protected]>
grounded042
commented
Jul 16, 2021
| If you are moving from v1 to v2 this is the place for you. | ||
|
|
||
| ### `jwtmiddleware.Options` | ||
| Now handled by individual [jwtmiddleware.Option](https://pkg.go.dev/github.com/auth0/go-jwt-middleware#Option) items. They can be passed to [jwtmiddleware.New](https://pkg.go.dev/github.com/auth0/go-jwt-middleware#New) after the [jwtmiddleware.ValidateToken](https://pkg.go.dev/github.com/auth0/go-jwt-middleware#ValidateToken) input: |
There was a problem hiding this comment.
Many of these links will not work until v2 is released.
Signed-off-by: Jon Carl <[email protected]>
grounded042
force-pushed
the
migration-guide
branch
from
dd27882 to
d67ba56
Compare
cyx
approved these changes
Jul 16, 2021
sergiught
pushed a commit
that referenced
this pull request
Nov 1, 2021
d10i
pushed a commit
to Hikely/go-jwt-middleware
that referenced
this pull request
Nov 2, 2021
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.
In prep for
v2this PR adds a migration guide explaining the differences when moving fromv1tov2.