Get-GitHubRelease¶
SYNOPSIS¶
List releases
SYNTAX¶
All (Default)¶
Get-GitHubRelease [-Owner <String>] [-Repo <String>] [-PerPage <Int32>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Latest¶
Get-GitHubRelease [-Owner <String>] [-Repo <String>] [-Latest] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
Tag¶
Get-GitHubRelease [-Owner <String>] [-Repo <String>] -Tag <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
ID¶
Get-GitHubRelease [-Owner <String>] [-Repo <String>] -ID <String> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION¶
This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the Repository Tags API. Information about published releases are available to everyone. Only users with push access will receive listings for draft releases.
EXAMPLES¶
EXAMPLE 1¶
Get-GitHubRelease -Owner 'octocat' -Repo 'hello-world'
Gets the releases for the repository 'hello-world' owned by 'octocat'.
EXAMPLE 2¶
Get-GitHubRelease -Owner 'octocat' -Repo 'hello-world' -Latest
Gets the latest releases for the repository 'hello-world' owned by 'octocat'.
EXAMPLE 3¶
Get-GitHubRelease -Owner 'octocat' -Repo 'hello-world' -Tag 'v1.0.0'
Gets the release with the tag 'v1.0.0' for the repository 'hello-world' owned by 'octocat'.
EXAMPLE 4¶
Get-GitHubRelease -Owner 'octocat' -Repo 'hello-world' -ID '1234567'
Gets the release with the ID '1234567' for the repository 'hello-world' owned by 'octocat'.
PARAMETERS¶
-Owner¶
The account owner of the repository. The name is not case sensitive.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
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: Named
Default value: (Get-GitHubContextSetting -Name Repo)
Accept pipeline input: False
Accept wildcard characters: False
-PerPage¶
The number of results per page (max 100).
Type: Int32
Parameter Sets: All
Aliases:
Required: False
Position: Named
Default value: 30
Accept pipeline input: False
Accept wildcard characters: False
-Latest¶
Get the latest release only
Type: SwitchParameter
Parameter Sets: Latest
Aliases:
Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Tag¶
The name of the tag to get a release from.
Type: String
Parameter Sets: Tag
Aliases: tag_name
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ID¶
The unique identifier of the release.
Type: String
Parameter Sets: ID
Aliases: release_id
Required: True
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.
INPUTS¶
OUTPUTS¶
NOTES¶
List releases Get the latest release