refactor(docs): replace ASPNETCORE_ENVIRONMENT with DOTNET_ENVIRONMENT#216
Merged
Conversation
…Builder()` - Updated configuration documentation to specify the exclusion of `ASPNETCORE_` prefixed variables. - Added warning about manually handling `ASPNETCORE_ENVIRONMENT` when using `CreateBuilder()`.
- Introduced a new `run-docs` task in LocalDevTasks.yml for running MKDocs with live reload. - Ensured compatibility with the existing developer workflow.
…ENVIRONMENT` - Updated `launchSettings.json` across multiple examples to use `DOTNET_ENVIRONMENT` instead. - Ensures consistency with modern .NET environment variable standards.
- Added `permalink` and `permalink_title` configuration to `toc` extension in `mkdocs.yml`. - Allows users to easily reference specific sections with anchor links.
… environment variables - Included code snippets for loading `ASPNETCORE_` prefixed environment variables after `CreateBuilder()`. - Added guidance for using `ASPNETCORE_` variables when creating `LambdaApplicationBuilder`.
j-d-ha
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #216 +/- ##
=======================================
Coverage 90.92% 90.92%
=======================================
Files 102 102
Lines 2227 2227
Branches 252 252
=======================================
Hits 2025 2025
Misses 109 109
Partials 93 93 Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
- Updated `validate-pr-title.yaml` to include `docs` in the list of valid PR title scopes. - Ensures consistency with recent documentation-related contributions.
…ilder()` docs - Clarified the order in which configuration providers are added when defaults are enabled. - Added details about disabling defaults with `LambdaApplicationOptions.DisableDefaults`. - Expanded provider list to include all relevant environment variable categories.
- Added YAML front matter to `index.md` to define metadata like `title`. - Prepares `index.md` for compatibility with static site generators like MkDocs.
|
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
1 participant
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.
🚀 Pull Request
📋 Summary
This PR refactors the codebase to use the standard
DOTNET_ENVIRONMENTenvironment variable instead ofASPNETCORE_ENVIRONMENT. The change includes:ASPNETCORE_ENVIRONMENTreferences in launchSettings.json files withDOTNET_ENVIRONMENTCreateBuilder()handlesASPNETCORE_prefixed environment variablesDOTNET_ENVIRONMENTrun-docstask for local documentation developmentThis aligns with modern .NET practices and reduces confusion around environment variable naming.
✅ Checklist
🧪 Related Issues or PRs
N/A - Internal code quality improvement
💬 Notes for Reviewers
The change is primarily about standardizing on
DOTNET_ENVIRONMENTinstead of the legacyASPNETCORE_ENVIRONMENTvariable. The new documentation explains that whileCreateBuilder()automatically mapsASPNETCORE_prefixed variables to configuration keys, developers should use the standardDOTNET_ENVIRONMENTvariable for environment detection.