New-BrownserveChangelogEntry¶
SYNOPSIS¶
Creates a new changelog entry for a given version in the standard Brownserve format.
SYNTAX¶
New-BrownserveChangelogEntry [[-ChangelogPath] <String>] [-Version] <SemanticVersion> -RepositoryOwner <String>
-RepositoryName <String> [-GitHubToken <String>] [-Notice <String>] [-BreakingChanges <String[]>]
[-Added <String[]>] [-Fixed <String[]>] [-Deprecated <String[]>] [-Removed <String[]>] [-Changed <String[]>]
[-Security <String[]>] [-Auto] [-SinceVersion <SemanticVersion>]
[<CommonParameters>]
DESCRIPTION¶
This cmdlet will generate a new changelog entry in the standard Brownserve format. Providing the -Auto parameter will cause the cmdlet to attempt to automatically populate the changelog entry with features, bugfixes and known issues based on the GitHub pull requests and issues that have been open/closed since the last release.
EXAMPLES¶
Example 1: Automatically generate a changelog entry¶
New-BrownserveChangelogEntry -RepositoryOwner "Brownserve-UK" -RepositoryName "Brownserve.PSTools" -Version 1.0.0 -Auto -GitHubToken $GitHubToken
This would generate a changelog entry for version 1.0.0 of the Brownserve.PSTools repository, automatically populating the features, bugfixes and known issues
PARAMETERS¶
-Added¶
New additions to include (manual override, used without -Auto)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Auto¶
An optional flag to indicate that the cmdlet should attempt to automatically populate the changelog entry with features, bugfixes and known issues
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-BreakingChanges¶
Breaking changes to include (manual override, used without -Auto)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Changed¶
Backwards-compatible changes to include (manual override, used without -Auto)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-ChangelogPath¶
The path to the changelog file
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: $PWD
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True
-Deprecated¶
Deprecations to include (manual override, used without -Auto)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Fixed¶
Bug fixes to include (manual override, used without -Auto)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-GitHubToken¶
The GitHub token to use for API calls
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Notice¶
An optional notice to attach to this release, it will appear between the release header and the features section.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Removed¶
Removed features to include (manual override, used without -Auto)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-RepositoryName¶
The name of the repo that the changelog belongs to (e.g. Brownserve.PSTools) This is used when auto-generating the changelog entry
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-RepositoryOwner¶
The owner of the repo that the changelog belongs to (e.g. Brownserve-UK) This is used when auto-generating the changelog entry
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Security¶
Security fixes to include (manual override, used without -Auto)
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-SinceVersion¶
The version to treat as the baseline when collecting merges and issues. Defaults to the most recent changelog entry. Pass the last stable version when promoting a pre-release to stable so that all changes since that stable release are included in the new entry.
Type: SemanticVersion
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Version¶
The version number to use for the new entry
Type: SemanticVersion
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.