doug-murphy / dougmurphy.targetframeworks.endoflife

This NuGet package contains an API to help determine if your Target Framework Moniker is, or will soon be, end of life.

Introduction

Knowing if your Target Framework Moniker (TFM) is End of Life (EOL) or not can be very important in certain circumstances. Maybe your company requires using supported target frameworks for compliance reasons, maybe you're publishing a NuGet package and want to make sure you're only supporting frameworks that Microsoft supports, or maybe you just want to make sure you're staying up-to-date. No matter the reason, this NuGet package can help you out with that.

Methods

GetAllEndOfLifeTargetFrameworkMonikers

By default, this method will get all TFMs that are currently EOL. Two overloads are provided where you can either pass in an explicit DateTime to get all TFMs that will be EOL by that date, or a TimeframeUnit with an amount to forecast out to a date relative to current date.

CheckTargetFrameworkForEndOfLife

This method takes in a singular TFM or semicolon-delimited pluralized TFM and returns back which one(s), if any, of them are currently EOL.

Example Usage

Checking if a specific TFM is EOL

using DougMurphy.TargetFrameworks.EndOfLife.Enums;
using DougMurphy.TargetFrameworks.EndOfLife.Helpers;
using DougMurphy.TargetFrameworks.EndOfLife.Models;
using System;
using System.Collections.Generic;

public void CheckIfSingleTfmIsEol() {
    var tfm = "net5.0";
    TargetFrameworkCheckResponse endOfLifeResults = TargetFrameworkEndOfLifeHelper.CheckTargetFrameworkForEndOfLife(tfm);

    if (endOfLifeResults.EndOfLifeTargetFrameworks.Count == 0) {
        //the specified TFM is not EOL
    }
    else {
        //the specified TFM is EOL
        foreach (KeyValuePair<string, DateTime> endOfLifeTargetFramework in endOfLifeResults.EndOfLifeTargetFrameworks) {
            Console.WriteLine($"{endOfLifeTargetFramework.Key} has an EOL date of {endOfLifeTargetFramework.Value}");
        }
    }
}

public void CheckIfAnyOfMultipleTfmIsEol() {
    var tfm = "net5.0;net45";
    TargetFrameworkCheckResponse endOfLifeResults = TargetFrameworkEndOfLifeHelper.CheckTargetFrameworkForEndOfLife(tfm);

    if (endOfLifeResults.EndOfLifeTargetFrameworks.Count == 0) {
        //none of the specified TFMs are EOL
    }
    else {
        //at least one of the specified TFMs are EOL
        foreach (KeyValuePair<string, DateTime> endOfLifeTargetFramework in endOfLifeResults.EndOfLifeTargetFrameworks) {
            Console.WriteLine($"{endOfLifeTargetFramework.Key} has an EOL date of {endOfLifeTargetFramework.Value}");
        }
    }
}

public void CheckIfSingleTfmIsEolWithinThreeMonths() {
    var tfm = "net5.0";
    TargetFrameworkCheckResponse endOfLifeResults = TargetFrameworkEndOfLifeHelper.CheckTargetFrameworkForEndOfLife(tfm, TimeframeUnit.Month, 3);

    if (endOfLifeResults.EndOfLifeTargetFrameworks.Count == 0) {
        //the specified TFM is not EOL
    }
    else {
        //the specified TFM is EOL
        foreach (KeyValuePair<string, DateTime> endOfLifeTargetFramework in endOfLifeResults.EndOfLifeTargetFrameworks) {
            Console.WriteLine($"{endOfLifeTargetFramework.Key} has an EOL date of {endOfLifeTargetFramework.Value}");
        }
    }
}

public void CheckIfAnyOfMultipleTfmIsEolWithinThreeMonths() {
    var tfm = "net5.0;net45";
    TargetFrameworkCheckResponse endOfLifeResults = TargetFrameworkEndOfLifeHelper.CheckTargetFrameworkForEndOfLife(tfm, TimeframeUnit.Month, 3);

    if (endOfLifeResults.EndOfLifeTargetFrameworks.Count == 0) {
        //none of the specified TFMs are EOL
    }
    else {
        //at least one of the specified TFMs are EOL
        foreach (KeyValuePair<string, DateTime> endOfLifeTargetFramework in endOfLifeResults.EndOfLifeTargetFrameworks) {
            Console.WriteLine($"{endOfLifeTargetFramework.Key} has an EOL date of {endOfLifeTargetFramework.Value}");
        }
    }
}

Getting a list of TFMs that are currently EOL, or will be within a specified forecasted timeframe

using DougMurphy.TargetFrameworks.EndOfLife.Enums;
using DougMurphy.TargetFrameworks.EndOfLife.Helpers;
using DougMurphy.TargetFrameworks.EndOfLife.Models;
using System;
using System.Collections.Generic;

public void GetAllTfmsThatAreEol() {
    TargetFrameworkCheckResponse endOfLifeResults = TargetFrameworkEndOfLifeHelper.GetAllEndOfLifeTargetFrameworkMonikers();

    foreach (KeyValuePair<string, DateTime> endOfLifeTargetFramework in endOfLifeResults.EndOfLifeTargetFrameworks) {
        Console.WriteLine($"{endOfLifeTargetFramework.Key} has an EOL date of {endOfLifeTargetFramework.Value}");
    }
}

public void GetAllTfmsThatAreEolWithinOneYear() {
    //Get all EOL TFMs that are currently EOL, or will be EOL within 1 year of current date.
    TargetFrameworkCheckResponse endOfLifeResults = TargetFrameworkEndOfLifeHelper.GetAllEndOfLifeTargetFrameworkMonikers(TimeframeUnit.Year, 1);

    foreach (KeyValuePair<string, DateTime> endOfLifeTargetFramework in endOfLifeResults.EndOfLifeTargetFrameworks) {
        Console.WriteLine($"{endOfLifeTargetFramework.Key} has an EOL date of {endOfLifeTargetFramework.Value}");
    }
}

Web API Host

If you don't have something set up to automatically update your NuGet packages, and you don't want to worry about updating this one as new TFMs and EOL dates are added, check out my API on GitHub for hassle-free updates!

dougmurphy.targetframeworks.endoflife's Issues

Support forecasting in CheckTargetFrameworkForEndOfLife()

When checking a TFM, you may want to know if that TFM is EOL within a specific forecasted date. You can work around this limitation right now by using the GetAllEndOfLifeTargetFrameworkMonikers() method and finding if your TFM is in the response, but that experience isn't very ideal.

Proposal is to add a method with signature CheckTargetFrameworkForEndOfLife(string rawTfm, TimeframeUnit timeframeUnit, byte timeframeAmount)

Return EOL date with TFM

Sometimes it may be required to know the date that a particular TFM goes EOL instead of simply knowing just that it is EOL. The EOL date for the TFM should be included in the response from the method.

Proposal is to change TargetFrameworkCheckResponse to have a IDictionary<string, DateTime> return type instead of IReadOnlyList<string> where the string key is the TFM and the DateTime value is the EOL date.

Add .NET 7 TFMs

The list of TFMs from .NET 7 should be finalized by now. We want to add those into the NuGet package.

The list appears to be the following:

• net7.0
• net7.0-android
• net7.0-ios
• net7.0-maccatalyst
• net7.0-macos
• net7.0-tvos
• net7.0-windows

References:
dotnet/docs#29069
dotnet/docs#30307
https://docs.microsoft.com/en-us/dotnet/standard/frameworks

Add support for .NET Framework 4.8.1

.NET Framework 4.8.1 has released. Let's add that TFM!

Update incorrect EOL dates

It seems that Microsoft made some minor changes to EOL dates for some frameworks since initial launch. We need to get these dates corrected.

The dates listed for .NET Core 3.1 EOL are incorrect. The NuGet package currently lists December 3, 2022. The actual EOL date for .NET Core 3.1 is December 13, 2022.

The dates listed for .NET 5 EOL are incorrect. The NuGet package currently lists May 8, 2022. The actual EOL date for .NET 5 is May 10, 2022.

The dates listed for .NET 6 EOL are incorrect. The NuGet package currently lists November 8, 2024. The actual EOL date for .NET 6 is November 12, 2024.