Skip to content
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

fix(docs): Correct default rollForward policy in global.json documentation #44996

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

nileshsheth
Copy link

@nileshsheth nileshsheth commented Feb 22, 2025

📜 Description

This PR updates the global-json.md documentation to correctly reflect the default rollForward behavior in the .NET SDK.

🔍 Issue

The documentation previously stated:

If no rollForward value is set, it uses latestPatch as the default rollForward policy.

However, based on actual SDK behavior and tracing logs (see dotnet/core-setup#6953), the default policy is actually patch, not latestPatch.

🛠 Fix

  • Updated the incorrect statement in global-json.md to specify patch as the default rollForward policy.
  • This aligns the documentation with the real behavior of the .NET SDK.

📎 Related Issues

📸 Verification

✅ The demo provided in the issue confirms that patch is the default policy.
✅ Tracing logs explicitly state rollForward = 'patch'.

📂 Files Changed

  • docs/core/tools/global-json.md

🔗 Additional Context

For backwards compatibility, the SDK defaults to patch when rollForward is not specified in global.json. This update ensures that the documentation accurately reflects this behavior.


Internal previews

📄 File 🔗 Preview link
docs/core/tools/global-json.md global.json overview

@nileshsheth nileshsheth requested review from tdykstra and a team as code owners February 22, 2025 08:09
@dotnetrepoman dotnetrepoman bot added this to the February 2025 milestone Feb 22, 2025
@dotnet-policy-service dotnet-policy-service bot added dotnet-fundamentals/svc dotnet-cli/subsvc community-contribution Indicates PR is created by someone from the .NET community. labels Feb 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-cli/subsvc dotnet-fundamentals/svc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant