Set-GitHubRelease¶
SYNOPSIS¶
Update a release
SYNTAX¶
Set-GitHubRelease [[-Owner] <String>] [[-Repo] <String>] [-ID] <String> [[-TagName] <String>]
[[-TargetCommitish] <String>] [[-Name] <String>] [[-Body] <String>] [-Draft] [-Prerelease]
[[-DiscussionCategoryName] <String>] [[-MakeLatest] <String>] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION¶
Users with push access to the repository can edit a release.
EXAMPLES¶
EXAMPLE 1¶
Set-GitHubRelease -Owner 'octocat' -Repo 'hello-world' -ID '1234567' -Body 'Release notes'
Updates the release with the ID '1234567' for the repository 'octocat/hello-world' with the body 'Release notes'.
PARAMETERS¶
-Owner¶
The account owner of the repository. The name is not case sensitive.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: (Get-GitHubContextSetting -Name Owner)
Accept pipeline input: False
Accept wildcard characters: False
-Repo¶
The name of the repository without the .git extension. The name is not case sensitive.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: (Get-GitHubContextSetting -Name Repo)
Accept pipeline input: False
Accept wildcard characters: False
-ID¶
The unique identifier of the release.
Type: String
Parameter Sets: (All)
Aliases: release_id
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TagName¶
The name of the tag.
Type: String
Parameter Sets: (All)
Aliases: tag_name
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TargetCommitish¶
Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. API Default: the repository's default branch.
Type: String
Parameter Sets: (All)
Aliases: target_commitish
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name¶
The name of the release.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Body¶
Text describing the contents of the tag.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Draft¶
Whether the release is a draft.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Prerelease¶
Whether to identify the release as a prerelease.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-DiscussionCategoryName¶
If specified, a discussion of the specified category is created and linked to the release. The value must be a category that already exists in the repository. For more information, see Managing categories for discussions in your repository.
Type: String
Parameter Sets: (All)
Aliases: discussion_category_name
Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MakeLatest¶
Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to true for newly published releases. legacy specifies that the latest release should be determined based on the release creation date and higher semantic version.
Type: String
Parameter Sets: (All)
Aliases: make_latest
Required: False
Position: 9
Default value: True
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf¶
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm¶
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
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.