Conversation
Introduces a versioning safeguard to the publish workflow
- Enable XML documentation generation in MiniJwt.Core.csproj - Create docs/ directory with getting-started, configuration, examples, and faq - Add three runnable sample applications: - ConsoleMinimal: Basic token generation/validation - ASPNetCoreAuth: Full ASP.NET Core API with JWT auth - WorkerService: Background service with periodic token generation - Update README.md with links to docs and samples - Update CI workflow to build samples - All samples build and run successfully Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
- Update launchUrl to root endpoint instead of weatherforecast - Replace ASPNetCoreAuth.http with complete API test scenarios - Fix Windows Service deployment instructions in WorkerService README - Use more specific Docker image tag for reproducibility Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
The NoWarn line was suppressing CS1591 warnings for missing XML comments. Removing it to keep warnings visible for proper documentation coverage. Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
Updated HTTPS application URL for the 'https' profile.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…mple Changed from `_tokenCount++` to `Interlocked.Increment(ref _tokenCount) - 1` to demonstrate thread-safe practices in sample code. While BackgroundService typically runs on a single thread, this shows best practices for scenarios where the pattern might be adapted for concurrent use. Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
…mples Add comprehensive documentation and runnable sample applications
Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
…lize methods Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…mpleOptionsMonitor helper Co-authored-by: jeanlrnt <63308635+jeanlrnt@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces significant enhancements to MiniJwt.Core, including performance optimizations, testability improvements, comprehensive documentation, and sample applications. The changes bump the version from 1.1.1 to 1.2.0, reflecting the addition of new features while maintaining backward compatibility.
Key changes:
- Added reflection caching to improve token generation and validation performance
- Integrated TimeProvider support for deterministic time-dependent testing
- Created three complete sample applications (ConsoleMinimal, ASPNetCoreAuth, WorkerService) with comprehensive documentation
- Added extensive documentation (getting started guide, configuration guide, examples, and FAQ)
- Enabled XML documentation generation for better IntelliSense support
Reviewed changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/MiniJwt.Core/Services/MiniJwtService.cs | Added reflection caching with ConcurrentDictionary and TimeProvider integration for testable time behavior |
| src/MiniJwt.Core/MiniJwt.Core.csproj | Version bump to 1.2.0, enabled XML documentation generation, added TimeProvider package for .NET 6/7 |
| src/MiniJwt.Tests/MiniJwtTests.Service.cs | Added comprehensive tests for TimeProvider functionality with FakeTimeProvider |
| src/MiniJwt.Tests/MiniJwtTests.ReflectionCache.cs | New test file verifying reflection cache behavior across multiple token operations |
| src/MiniJwt.Tests/MiniJwt.Tests.csproj | Added Microsoft.Extensions.TimeProvider.Testing package for time-based testing |
| samples/ConsoleMinimal/* | Complete console application sample demonstrating basic token generation and validation |
| samples/ASPNetCoreAuth/* | Full ASP.NET Core web API sample with JWT authentication and authorization |
| samples/WorkerService/* | Background service sample showing periodic token generation in worker services |
| docs/getting-started.md | Comprehensive getting started guide with installation and quick start instructions |
| docs/configuration.md | Detailed configuration guide covering all MiniJwtOptions and integration patterns |
| docs/examples.md | Extensive code examples for various integration scenarios including TimeProvider testing |
| docs/faq.md | Thorough FAQ covering common questions and security best practices |
| README.md | Updated with links to new documentation and sample applications |
| .github/workflows/ci.yml | Added sample project builds to CI pipeline |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
No description provided.