Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 152 additions & 0 deletions docs/standard/library-guidance/dependencies-net.md
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need to add this to the TOC somewhere. Maybe below this article in this file?

Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
# Guidance for Selecting .NET Library Dependency Versions

When building libraries that target multiple .NET versions, choosing dependency versions has implications for compatibility, servicing, and ecosystem health. This document outlines the main strategies, their tradeoffs, and recommendations.

---
Comment on lines +6 to +8
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When building libraries that target multiple .NET versions, choosing dependency versions has implications for compatibility, servicing, and ecosystem health. This document outlines the main strategies, their tradeoffs, and recommendations.
---
When you build libraries that target multiple .NET versions, choosing dependency versions has implications for compatibility, servicing, and ecosystem health. This article outlines the main strategies, their tradeoffs, and recommendations.


## **Overview**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## **Overview**
## Overview


Library authors face challenges when deciding which version of a .NET dependency to reference. Newer versions have more API and features, but may require a local redistribution increasing servicing responsibilities of the library and size of the application. The decision impacts:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Library authors face challenges when deciding which version of a .NET dependency to reference. Newer versions have more API and features, but may require a local redistribution increasing servicing responsibilities of the library and size of the application. The decision impacts:
Library authors face challenges when deciding which version of a .NET dependency to reference. Newer versions have more APIs and features but might require a local redistribution, which increases servicing responsibilities of the library and size of the application. The decision impacts:


- **Friction of updates** on older runtimes
- **Engineering complexity** in maintaing the solution
- **Servicing complexity** in managing supported releases

This guidance provides options, tradeoffs, and a decision matrix to help you choose the best approach.
✔️ DO be deliberate in choosing a dependency policy for your library
✔️ DO remove out of support target frameworks from your package.
✔️ CONSIDER choosing an approach that minimizes engineering costs and adjusting based on customer feedback
✔️ CONSIDER changing your approach through the lifecycle of your library
❌ DO NOT assume any policy is incorrect, all policies are technically sound and supported with different tradeoffs for consumption

---

## **Strategies for Dependency Version Selection**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## **Strategies for Dependency Version Selection**
## Strategies for dependency version selection


### **Option 1: Latest Supported Versions**

Check failure on line 26 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:26 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### **Option 1: Latest Supported Versions**"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
Reference the latest supported version of the dependency across all target frameworks. For example: reference 10.0 packages on `netstandard2.0`, `net8.0`, `net9.0`, and `net10.0`
> **Note:** The lifetime of the latest Short-Term Support (STS) release now aligns with the latest LTS release, so choosing “latest” effectively means choosing the latest supported version regardless of STS or LTS designation.
> **Note:** Not all packages support targeting older frameworks in their latest version. For example: `Microsoft.AspNetCore.Authorization`. These packages must be excluded from this policy and must always follow option 2 when used.
Comment on lines +32 to +33
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
> **Note:** The lifetime of the latest Short-Term Support (STS) release now aligns with the latest LTS release, so choosing “latest” effectively means choosing the latest supported version regardless of STS or LTS designation.
> **Note:** Not all packages support targeting older frameworks in their latest version. For example: `Microsoft.AspNetCore.Authorization`. These packages must be excluded from this policy and must always follow option 2 when used.
> [!NOTE]
> - The lifetime of the latest Short-Term Support (STS) release now aligns with the latest LTS release, so choosing “latest” effectively means choosing the latest supported version regardless of STS or LTS designation.
> - Not all packages support targeting older frameworks in their latest version, for example, `Microsoft.AspNetCore.Authorization`. If you reference these packages, exclude them from this policy and follow option 2 instead.


**Pros**
- Simplifies decision-making and aligns with stability expectations.

Check failure on line 32 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:32 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Simplifies decision-making a..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- Reduces complexity in dependency management.
- Encourages modernization and access to new features.

**Cons**
- Older TFMs may require app-local deployments, increasing app size.

Check failure on line 37 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:37 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Older TFMs may require app-l..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- Larger number of packages to update in comparison to relying on framework provided API.
- May create friction for customers who are not on the latest supported runtime.
- May prevent consumption in enviroments where dependencies are managed by a host application - eg: MSBuild, Visual Studio, Azure Functions V1.
Comment on lines +45 to +46
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- May create friction for customers who are not on the latest supported runtime.
- May prevent consumption in enviroments where dependencies are managed by a host application - eg: MSBuild, Visual Studio, Azure Functions V1.
- Might create friction for customers who aren't on the latest supported runtime.
- Might prevent consumption in environments where dependencies are managed by a host application - for example, MSBuild, Visual Studio, and Azure Functions V1.


---

### **Option 2: TFM-Specific Versions**

Check failure on line 44 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:44 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### **Option 2: TFM-Specific Versions**"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
Reference different dependency versions per Target Framework Moniker (TFM). Don't reference packages when the framework provides the API. For example: 8.0 packages on `net8.0`, 9.0 packages on `net9.0`, and so on.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Reference different dependency versions per Target Framework Moniker (TFM). Don't reference packages when the framework provides the API. For example: 8.0 packages on `net8.0`, 9.0 packages on `net9.0`, and so on.
Reference different dependency versions per Target Framework Moniker (TFM). Don't reference packages when the framework provides the API. For example, reference 8.0 packages on `net8.0`, 9.0 packages on `net9.0`, and so on.


**Pros**
- Minimizes change for apps running on older runtimes.

Check failure on line 48 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:48 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Minimizes change for apps ru..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- Minimizes app-local libraries app size on older runtimes. Uses runtime optimized library on older runtimes.

**Cons**
- Reduced API available to library which may lead to more complex implementations (polyfills). Polyfills increase the total cost of engineering and servicing.

Check failure on line 52 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:52 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Reduced API available to lib..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- Slows innovation in libraries.
- Greater complexity of infrastructure to maintain seperate dependency sets per target framework. Central packagge management and dependabot can be be configured to work with this, but it's challenging to get it right.

---

### **Option 3: Branching**

Check failure on line 58 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:58 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### **Option 3: Branching**"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
Comment on lines +65 to +67
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
---
### **Option 3: Branching**
### Option 3: Branching

Reference the latest supported version of the dependency across all target frameworks, but branch your library in sync with target frameworks. This is the same as Option 1, but each time a new framework is added, a new major version / branch is created to allow for updating the major version of dependencies and adding the new target framework.

**Pros**
- Balances compatibility with flexibility for fast-moving areas.

Check failure on line 62 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:62 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Balances compatibility with ..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- Encourages modernization and access to new features.
- Simplifies decision-making and aligns with stability expectations.
- Reduces complexity in dependency management.

**Cons**
- Increased infrastructure cost to maintain concurrent branches.

Check failure on line 68 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Lists should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:68 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- Increased infrastructure cos..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md032.md
- No new features for folks who want to stay on older dependencies.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- No new features for folks who want to stay on older dependencies.
- No new features for consumers who want to stay on older dependencies.


---

## **Decision Matrix**

| Strategy | Update Friction | Engineering Cost | Servicing Cost |
|---------------------------------------|------------------|------------------|------------------|
| Latest Supported Versions (Option 1) | Moderate | Low | Moderate |
| TFM-Specific Versions (Option 2) | Low | High | Low / Moderate |
| Branching | Low | Low | High |

---

## **Key Tradeoffs**

- **Friction vs. Innovation:** Latest versions offer new features but have more friction for existing applications on older runtimes.
- **Engineering cost:** Configuring multiple dependency groups, dependency updates for those, and managing API gaps can all accumulate to slow down innovation in a fast moving library.
- **Servicing cost:** More package dependencies means more updates. More branches mean more concurrent builds that need to stay healthy. Additional code in the form of polyfills means more LOC with potential bugs.

---

## **Recommended Guidance**

- Option 1: Recommended for libraries moving fast and undergoing lots of innovation and feature development. Consumers are more likely to be on the latest framework.
- Option 2: Recommended for libraries that are stable and do not require new features. Could be a transition strategy when a library reaches maturity and stops taking large features/
- Option 3: Recommended for libraries that are part of .NET or receive strong customer feedback that option 1 is limiting consumption or blocking adoption. Could be a transition strategy when Option 1 has too much friction.

---

## **Examples**
Comment on lines +111 to +113
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
---
## **Examples**
## Examples


### Example 1: Latest Supported Version

Check failure on line 101 in docs/standard/library-guidance/dependencies-net.md

View workflow job for this annotation

GitHub Actions / lint

Headings should be surrounded by blank lines

docs/standard/library-guidance/dependencies-net.md:101 MD022/blanks-around-headings Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Example 1: Latest Supported Version"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md022.md
```xml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```xml
```xml

<PropertyGroup>
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="System.Text.Json" Version="10.0.0" />
</ItemGroup>
```

### Example 2: TFM-Specific Versions
```xml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```xml
```xml

<PropertyGroup>
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
</PropertyGroup>
<ItemGroup>
<PackageReference Condition="'$(TargetFramework)' == 'net8.0'" Include="System.Text.Json" Version="8.0.0" />
<PackageReference Condition="'$(TargetFramework)' == 'net9.0'" Include="System.Text.Json" Version="9.0.0" />
<PackageReference Condition="'$(TargetFramework)' == 'net10.0'" Include="System.Text.Json" Version="10.0.0" />
</ItemGroup>
```

### Example 3: Branching
Branch: release/8.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Branch: release/8.0
Branch: release/8.0

```xml
<PropertyGroup>
<TargetFrameworks>net6.0;net7.0;net8.0</TargetFrameworks>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="System.Text.Json" Version="8.0.0" />
</ItemGroup>
```

Branch: release/9.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Branch: release/9.0
Branch: release/9.0

```xml
<PropertyGroup>
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="System.Text.Json" Version="9.0.0" />
</ItemGroup>
```

Branch: release/10.0
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Branch: release/10.0
Branch: release/10.0

```xml
<PropertyGroup>
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="System.Text.Json" Version="10.0.0" />
</ItemGroup>
```
Loading