Get-GitHubRelease

SYNOPSIS

Retrieves GitHub release information for a repository.

SYNTAX

Latest (Default)

Get-GitHubRelease -Owner <string> -Repository <string> [-Context <Object>] [<CommonParameters>]

AllVersions

Get-GitHubRelease -Owner <string> -Repository <string> -AllVersions [-PerPage <int>]
 [-Context <Object>] [<CommonParameters>]

Tag

Get-GitHubRelease -Owner <string> -Repository <string> -Tag <string> [-Context <Object>]
 [<CommonParameters>]

ID

Get-GitHubRelease -Owner <string> -Repository <string> -ID <string> [-Context <Object>]
 [<CommonParameters>]

ALIASES

This cmdlet has the following aliases, {{Insert list of aliases}}

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

-AllVersions

Get all releases instead of just the latest.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AllVersions
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-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: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

The unique identifier of the release.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ID
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Owner

The account owner of the repository. The name is not case sensitive.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Organization
- User
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-PerPage

The number of results per page (max 100).

Type: System.Nullable`1[System.Int32]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: AllVersions
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Repository

The name of the repository without the .git extension. The name is not case sensitive.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: true
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Tag

The name of the tag to get a release from.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Tag
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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

INPUTS

GitHubRepository

{{ Fill in the Description }}

System.String

{{ Fill in the Description }}

OUTPUTS

GitHubRelease

{{ Fill in the Description }}

NOTES

RELATED LINKS