New GitHubPullRequest - X-Guardian/PowerShellForGitHub GitHub Wiki
Create a new pull request in the specified repository.
New-GitHubPullRequest [-OwnerName <String>] [-RepositoryName <String>] -Title <String> [-Body <String>]
-Head <String> -Base <String> [-HeadOwner <String>] [-MaintainerCanModify] [-Draft] [-AccessToken <String>]
[-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
New-GitHubPullRequest [-OwnerName <String>] [-RepositoryName <String>] -Issue <Int32> -Head <String>
-Base <String> [-HeadOwner <String>] [-MaintainerCanModify] [-Draft] [-AccessToken <String>] [-NoStatus]
[-WhatIf] [-Confirm] [<CommonParameters>]
New-GitHubPullRequest -Uri <String> -Issue <Int32> -Head <String> -Base <String> [-HeadOwner <String>]
[-MaintainerCanModify] [-Draft] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
New-GitHubPullRequest -Uri <String> -Title <String> [-Body <String>] -Head <String> -Base <String>
[-HeadOwner <String>] [-MaintainerCanModify] [-Draft] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Opens a new pull request from the given branch into the given branch in the specified repository.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
$prParams = @{
OwnerName = 'Microsoft' Repository = 'PowerShellForGitHub' Title = 'Add simple file to root' Head = 'octocat:simple-file' Base = 'master' Body = "Adds a simple text file to the repository root.`n`nThis is an automated PR!" MaintainerCanModify = $true } $pr = New-GitHubPullRequest @prParams
New-GitHubPullRequest -Uri 'https://github.com/PowerShell/PSScriptAnalyzer' -Title 'Add test' -Head simple-test -HeadOwner octocat -Base development -Draft -MaintainerCanModify
New-GitHubPullRequest -Uri 'https://github.com/PowerShell/PSScriptAnalyzer' -Issue 642 -Head simple-test -HeadOwner octocat -Base development -Draft
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.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the target branch of the pull request (where the changes in the head will be merged to).
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe text description of the pull request.
Type: System.String
Parameter Sets: Elements_Title, Uri_Title
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseIf set, opens the pull request as a draft.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the head branch (the branch containing the changes to be merged).
May also include the name of the owner fork, in the form "${fork}:${branch}".
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of fork that the change is coming from.
Used as the prefix of
If unspecified, the unprefixed branch name is used, creating a pull request from the $OwnerName fork of the repository.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe GitHub issue number to open the pull request to address.
Type: System.Int32
Parameter Sets: Elements_Issue, Uri_Issue
Aliases: IssueNumber
Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseIf set, allows repository maintainers to commit changes to the head branch of this pull request.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseIf 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.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseOwner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.
Type: System.String
Parameter Sets: Elements_Title, Elements_Issue
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseName of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.
Type: System.String
Parameter Sets: Elements_Title, Elements_Issue
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe title of the pull request to be created.
Type: System.String
Parameter Sets: Elements_Title, Uri_Title
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseUri for the repository. The OwnerName and RepositoryName will be extracted from here instead of needing to provide them individually.
Type: System.String
Parameter Sets: Uri_Issue, Uri_Title
Aliases: RepositoryUrl
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalsePrompts you for confirmation before running the cmdlet.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet is not run.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.