Skip to content

Get-GitHubIssues

SYNOPSIS

Gets the issues for a given GitHub repository

SYNTAX

Get-GitHubIssues [-Token] <String> [-RepositoryOwner] <String> [-RepositoryName] <String>
 [[-State] <GitHubIssueState>] [<CommonParameters>]

DESCRIPTION

Gets the issues for a given GitHub repository

EXAMPLES

Example 1

PS C:\> Get-GitHubIssues -GitHubToken $GitHubToken -RepositoryOwner 'Brownserve-UK' -RepositoryName 'Brownserve.PSTools'

This will return all open issues for the Brownserve.PSTools repository

PARAMETERS

-RepositoryName

The name of the repository to get the issues for

Type: String
Parameter Sets: (All)
Aliases: RepoName

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

-RepositoryOwner

The owner of the repository to get the issues for

Type: String
Parameter Sets: (All)
Aliases: GitHubOrganisation, GitHubOrganization, GitHubOrg

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

-State

The state of the issues to get. Valid values are Open, Closed and All

Type: GitHubIssueState
Parameter Sets: (All)
Aliases:
Accepted values: Open, Closed, All

Required: False
Position: 3
Default value: Open
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Token

The GitHub token to use for authentication

Type: String
Parameter Sets: (All)
Aliases: GitHubToken, GitHubPAT

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

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

System.String

GitHubIssueState

OUTPUTS

System.Object

NOTES