Get-GitHubRelease

NAME Get-GitHubRelease



SYNOPSIS

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





SYNTAX

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>] -ReleaseId <String> [-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> -ReleaseId <String> [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]

[<CommonParameters>]



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





DESCRIPTION

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





PARAMETERS

-OwnerName <String>

Owner of the repository.

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-RepositoryName <String>

Name of the repository.

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



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Uri <String>

Uri for the repository.

The OwnerName and RepositoryName will be extracted from here instead of needing to provide

them individually.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ReleaseId <String>

Specific releaseId of a release.

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



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Latest [<SwitchParameter>]

Retrieve only the latest release.

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



Required? true

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Tag <String>

Retrieves a list of releases with the associated tag.

This is an optional parameter which can filter the list of releases.



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-AccessToken <String>

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.



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-NoStatus [<SwitchParameter>]

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.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Information about published releases are available to everyone. Only users with push

access will receive listings for draft releases.



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Get-GitHubRelease



Gets all releases for the default configured owner/repository.









-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-GitHubRelease -ReleaseId 12345



Get a specific release for the default configured owner/repository









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-GitHubRelease -OwnerName dotnet -RepositoryName core



Gets all releases from the dotnet\\core repository.









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-GitHubRelease -Uri https://github.com/microsoft/PowerShellForGitHub



Gets all releases from the microsoft/PowerShellForGitHub repository.









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-GitHubRelease -OwnerName dotnet -RepositoryName core -Latest



Gets the latest release from the dotnet\\core repository.









-------------------------- EXAMPLE 6 --------------------------



PS C:\\>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.











RELATED LINKS