ZimLabs.DotnetReleaseHelper 1.0.0

ZimLabs.DotnetReleaseHelper

Content

• General
• Version number format
• Settings
• Custom actions
• Usage

General

This repository provides a class library that can be used to easily create a .NET release.

The CreateRelease method performs the following steps:

1. Update the version number with the desired format. For more information see Version number format.
2. Publish
   1. Cleaning up the bin folder (if desired)
   2. Creation of the release with the help of "dotnet publish" (a publish profile can be specified)
3. Packing the publish folder as a ZIP archive (if desired)

For more information about the settings see Settings

NOTE: It's also possible to execute custom actions between the steps. For more information see Custom actions.

Version number format

The following to formats are available:

1. Your own version number
2. Your own version generator
3. Year.CalendarWeek.Build.MinutesSinceMidnight
4. Year.DayOfTheYear.Build.MinutesSinceMidnight

Explanation

1. Major - Year: The last two digits of the current year. 2023 > 23
2. Minor:
   • CalendarWeek: The current calendar week. NOTE: The german format will be used.
   • DayOfTheYear: The day of the year. For example, the 14.02 is the 35th day of the year
3. Build: The build number. The number starts with 0 and will be increased by one when the Major and Minor value of the old and new version are equal.
4. Revision - MinutesSinceMidnight: If it's 4:30 PM you will get 990: 4 PM = 16 o'clock = 16 * 60 = 960 + 30 Minutes = 990

Settings

The following settings are available:

Custom actions

It's possible to perform a custom action between the normal steps. For example, you can use a custom action to copy some additional files to the publishing directory after the creation process so that they are added to the zip archive.

These are the normal steps:

1. Update the version number with the desired format. For more information see Version number format.
2. Publish
   1. Cleaning up the bin folder (if desired)
   2. Creation of the release with the help of "dotnet publish" (a publish profile can be specified)
3. Packing the publish folder as a ZIP archive (if desired)

How to create a custom action

A custom action has four properties:

1. Name: The name of the custom action (only for logging purpose)
2. ExecutionType: Specifies when the action should be excuted. The following options are available:
   • BeforeVersionUpdate: This is the first possibility (before step 1)
   • BeforePublish: Action will be executed after the version update and before the publish process (between step 2.1 and 2.2)
   • AfterPublish: Action will be executed after the publish process (between step 2 and 3)
   • AfterZip: Action will be executed after the zipping (after step 3)
3. Action: The action which should be executed
4. StopOnException: The value that specified whether the entire process should be stopped if an exception occurs during the execution of the action

Example

public static void Main(string[] args)
{
    // Create a new instance of the release helper
    var releaseHelper = new ReleaseHelper(LogEventLevel.Information); 

    // Create the settings...
    var settings = new ReleaseSettings();

    // Create the custom action
    var customAction = new CustomAction
    {
        Name = "ExtractPackages", // The name
        Action = ExtractPackages, // The actual action
        ExecutionType = ActionExecutionType.BeforePublish, // Execute it before the publish process (between step 2.1 and 2.2)
        StopOnException = true // Stop the process when an error occurs
    };

    // Start the release
    releaseHelper.CreateRelease(settings, customAction);
}

// This method extracts the "PackageReference" entries of the project file
// and write them into a CSV file
private static void ExtractPackages(ReleaseSettings settings)
{
    var xmlDoc = XDocument.Load(settings.ProjectFile);

    var packages = (from element in xmlDoc.Descendants()
        where element.Name.LocalName.Equals("PackageReference")
        let package = element?.Attribute("Include")?.Value ?? string.Empty
        let version = element?.Attribute("Version")?.Value ?? string.Empty
        where !string.IsNullOrEmpty(package) &&
                !string.IsNullOrEmpty(version)
        select $"{package};{version}").ToList();

    // Export the data
    Log.Information("{count} packages extracted.", packages.Count);
    File.WriteAllLines("SomePathHere", packages);
}

Usage