Set GitHubRelease

Set-GitHubRelease

SYNOPSIS

Edits a release for a repository on GitHub.

SYNTAX

Elements

Set-GitHubRelease [-OwnerName <String>] [-RepositoryName <String>] [-Release] <Int64> [-Tag <String>]
 [-Committish <String>] [-Name <String>] [-Body <String>] [-Draft] [-PreRelease] [-PassThru]
 [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Uri

Set-GitHubRelease [-Uri] <String> [-Release] <Int64> [-Tag <String>] [-Committish <String>] [-Name <String>]
 [-Body <String>] [-Draft] [-PreRelease] [-PassThru] [-AccessToken <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Edits a release for a repository on GitHub.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

Set-GitHubRelease -OwnerName microsoft -RepositoryName PowerShellForGitHub -Tag 0.12.0 -Body 'Adds core support for Projects'

PARAMETERS

-AccessToken

If provided, this will be used as the AccessToken for authentication with the REST Api. Otherwise, will attempt to use the configured value or will run unauthenticated.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Body

Text describing the contents of the tag.

Type: System.String
Parameter Sets: (All)
Aliases: Description

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

-Committish

The committish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Will default to the repository's default branch (usually 'master').

Type: System.String
Parameter Sets: (All)
Aliases: Commitish, BranchName, Sha

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

-Draft

Specifies if this should be a draft (unpublished) release or a published one.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Name

The name of the release.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

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

-PassThru

Returns the updated GitHub Release. By default, this cmdlet does not generate any output. You can use "Set-GitHubConfiguration -DefaultPassThru" to control the default behavior of this switch.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PreRelease

Indicates if this should be identified as a pre-release or as a full release.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Release

The ID of the release to edit.

Type: System.Int64
Parameter Sets: (All)
Aliases: ReleaseId

Required: True
Position: 3
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

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

-Tag

The name of the tag.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-Uri

Uri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.

Type: System.String
Parameter Sets: Uri
Aliases: RepositoryUrl

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Release

GitHub.ReleaseAsset

GitHub.Repository

OUTPUTS

GitHub.Release

NOTES

Requires push access to the repository.

RELATED LINKS