ModuleForge

Get-MFGitChangeLog

SYNOPSIS

Generates a markdown changelog from Git commit messages between the latest and previous tags.

SYNTAX

Default (Default)

Get-MFGitChangeLog [-ChangeLogTypes <Hashtable>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

FromLastTag

Get-MFGitChangeLog [-ChangeLogTypes <Hashtable>] [-FromLastTag] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

All

Get-MFGitChangeLog [-ChangeLogTypes <Hashtable>] [-All] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

This function retrieves Git commit messages between the latest and previous tags, categorizes them based on predefined types, and formats them into a markdown changelog. It ensures the Git environment is correctly set up and handles errors if Git is not recognized or tags are not found.

EXAMPLES

EXAMPLE 1

Get-MFGitChangeLog

DESCRIPTION Call the `Get-MFGitChangeLog` function with default change Log Types. The function will generate a markdown changelog that can be sent to release or artifact notes.

OUTPUT

Change Log

Version: v1.0.0 –> v1.1.0

New Features

EXAMPLE 2

Get-MFGitChangeLog -ChangeLogTypes @{
'feat' = 'New Features'
'fix' = 'Bug Fixes'
'chore' = 'Chore and Pipeline work'
'test' = 'Test Changes'
}

DESCRIPTION This example demonstrates how to call the `Get-MFGitChangeLog` function with a custom set of changelog types, in case you want to control your own

OUTPUT

Change Log

Version: v1.0.0 –> v1.1.0

New Features

EXAMPLE 3

Get-MFGitChangeLog -All

DESCRIPTION Generates a full markdown changelog with all versions.

OUTPUT

Change Log

Version: v1.0.0 –> v1.1.0

New Features

EXAMPLE 4

get-mfGitChangeLog -fromLastTag

DESCRIPTION Generates markdown changelog from commit messages from the last tag until now (Head)

OUTPUT

Change Log

New Features

PARAMETERS

-ChangeLogTypes

Change Logs Types and corresponding Heading. Hashtable/Key Value Pair expected. Key = git type; Value = Heading ‘chore’ = ‘Chore and Pipeline work’ ‘test’ = ‘Testing’

Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: @{
            'feat' = 'New Features'
            'fix' = 'Bug Fixes'
            'docs' = 'Documentation Changes'
            'refactor' = 'Code Rewrite/Refactor'
            'perf' = 'Performance Improvements'
            #'chore' = 'Chore and Pipeline work'
            #'test' = 'Testing'
        }
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-All

Switch to get a full changelog for ALL tags

Type: SwitchParameter
Parameter Sets: All
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-FromLastTag

Switch to get the changelog from the last tag until this point.

Type: SwitchParameter
Parameter Sets: FromLastTag
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

[hashtable] - Accepts changeLogTypes hashtable via parameter or pipeline

OUTPUTS

[STRING] - Returns a Markdown Compatible string output that can be redirected to a file

NOTES

Author: Adrian Andersson

This site is open source. Improve this page.