Retrieves information about a release or list of releases on GitHub.

Get-GitHubRelease [-OwnerName <String>] [-RepositoryName <String>] [-AccessToken <String>] [-NoStatus]
 [-WhatIf] [-Confirm] [<CommonParameters>]

Get-GitHubRelease [-OwnerName <String>] [-RepositoryName <String>] -Tag <String> [-AccessToken <String>]
 [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-GitHubRelease [-OwnerName <String>] [-RepositoryName <String>] [-Latest] [-AccessToken <String>]
 [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-GitHubRelease [-OwnerName <String>] [-RepositoryName <String>] -Release <Int64> [-AccessToken <String>]
 [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]

Get-GitHubRelease -Uri <String> -Tag <String> [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Get-GitHubRelease -Uri <String> [-Latest] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Get-GitHubRelease -Uri <String> -Release <Int64> [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Get-GitHubRelease -Uri <String> [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]

Retrieves information about a release or list of releases on GitHub.

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

Get-GitHubRelease

Gets all releases for the default configured owner/repository.

Get-GitHubRelease -Release 12345

Get a specific release for the default configured owner/repository

Get-GitHubRelease -OwnerName dotnet -RepositoryName core

Gets all releases from the dotnet\core repository.

Get-GitHubRelease -Uri https://github.com/microsoft/PowerShellForGitHub

Gets all releases from the microsoft/PowerShellForGitHub repository.

Get-GitHubRelease -OwnerName dotnet -RepositoryName core -Latest

Gets the latest release from the dotnet\core repository.

Get-GitHubRelease -Uri https://github.com/microsoft/PowerShellForGitHub -Tag 0.8.0

Gets the release tagged with 0.8.0 from the microsoft/PowerShellForGitHub repository.

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

Retrieve only the latest release. This is an optional parameter which can limit the results to a single release.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: Elements-Latest, Uri-Latest
Aliases:

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

If this switch is specified, long-running commands will run on the main thread with no commandline status update. When not specified, those commands run in the background, enabling the command prompt to provide status information. If not supplied here, the DefaultNoStatus configuration property value will be used.

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

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

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

Type: System.String
Parameter Sets: Elements, Elements-Tag, Elements-Latest, Elements-ReleaseId
Aliases:

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

The ID of a specific release. This is an optional parameter which can limit the results to a single release.

Type: System.Int64
Parameter Sets: Elements-ReleaseId, Uri-ReleaseId
Aliases: ReleaseId

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

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

Type: System.String
Parameter Sets: Elements, Elements-Tag, Elements-Latest, Elements-ReleaseId
Aliases:

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

Retrieves a list of releases with the associated tag. This is an optional parameter which can filter the list of releases.

Type: System.String
Parameter Sets: Elements-Tag, Uri-Tag
Aliases:

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

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-Tag, Uri-Latest, Uri-ReleaseId, Uri
Aliases: RepositoryUrl

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

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

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

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

Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.