Get-GitHubRelease¶
SYNOPSIS¶
Retrieves GitHub release information for a repository.
SYNTAX¶
Latest (Default)¶
Get-GitHubRelease -Owner <String> -Repository <String> [-Context <Object>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
AllVersions¶
Get-GitHubRelease -Owner <String> -Repository <String> [-AllVersions] [-PerPage <Int32>] [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Tag¶
Get-GitHubRelease -Owner <String> -Repository <String> -Tag <String> [-Context <Object>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
ID¶
Get-GitHubRelease -Owner <String> -Repository <String> -ID <String> [-Context <Object>]
[-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' -Repository 'hello-world'
Gets the latest release for the repository 'hello-world' owned by 'octocat'.
EXAMPLE 2¶
Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -AllVersions
Gets all releases for the repository 'hello-world' owned by 'octocat'.
EXAMPLE 3¶
Get-GitHubRelease -Owner 'octocat' -Repository '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' -Repository '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: Organization, User
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Repository¶
The name of the repository without the .git extension. The name is not case sensitive.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-AllVersions¶
Get all releases instead of just the latest.
Type: SwitchParameter
Parameter Sets: AllVersions
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:
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:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PerPage¶
The number of results per page (max 100).
Type: Int32
Parameter Sets: AllVersions
Aliases:
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-Context¶
The context to run the command in. Used to get the details for the API call. Can be either a string or a GitHubContext object.
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: (Get-GitHubContext)
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¶
GitHubRepository¶
OUTPUTS¶
GitHubRelease¶
NOTES¶
RELATED LINKS¶
https://psmodule.io/GitHub/Functions/Releases/Get-GitHubRelease/