Skip to content

New GitHubProject

Howard Wolosky edited this page Oct 5, 2020 · 2 revisions

New-GitHubProject

SYNOPSIS

Creates a new GitHub project for the given repository.

SYNTAX

Elements (Default)

New-GitHubProject -OwnerName <String> -RepositoryName <String> -ProjectName <String> [-Description <String>]
 [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Uri

New-GitHubProject -Uri <String> -ProjectName <String> [-Description <String>] [-AccessToken <String>] [-WhatIf]
 [-Confirm] [<CommonParameters>]

Organization

New-GitHubProject -OrganizationName <String> -ProjectName <String> [-Description <String>]
 [-AccessToken <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

User

New-GitHubProject [-UserProject] -ProjectName <String> [-Description <String>] [-AccessToken <String>]
 [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Creates a new GitHub project for the given repository.

The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub

EXAMPLES

EXAMPLE 1

New-GitHubProject -OwnerName microsoft -RepositoryName PowerShellForGitHub -ProjectName TestProject

Creates a project called 'TestProject' for the microsoft\PowerShellForGitHub repository.

EXAMPLE 2

New-GitHubProject -OrganizationName Microsoft -ProjectName TestProject -Description 'This is just a test project'

Create a project for the Microsoft organization called 'TestProject' with a description.

EXAMPLE 3

New-GitHubProject -Uri https://github.com/Microsoft/PowerShellForGitHub -ProjectName TestProject

Create a project for the microsoft\PowerShellForGitHub repository using the Uri called 'TestProject'.

EXAMPLE 4

New-GitHubProject -UserProject -ProjectName 'TestProject'

Creates a project for the signed in user called 'TestProject'.

PARAMETERS

-AccessToken

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: False

-Description

Short description for the new project.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OrganizationName

The name of the organization to create the project under.

Type: System.String
Parameter Sets: Organization
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OwnerName

Owner of the repository. If not supplied here, the DefaultOwnerName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProjectName

{{ Fill ProjectName Description }}

Type: System.String
Parameter Sets: (All)
Aliases: Name

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RepositoryName

Name of the repository. If not supplied here, the DefaultRepositoryName configuration property value will be used.

Type: System.String
Parameter Sets: Elements
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Uri

Uri 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
Aliases: RepositoryUrl

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

-UserProject

If this switch is specified creates a project for your user.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: User
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts 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: False

-WhatIf

Shows 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: 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

GitHub.Branch

GitHub.Content

GitHub.Event

GitHub.Issue

GitHub.IssueComment

GitHub.Label

GitHub.Milestone

GitHub.PullRequest

GitHub.Project

GitHub.ProjectCard

GitHub.ProjectColumn

GitHub.Reaction

GitHub.Release

GitHub.ReleaseAsset

GitHub.Repository

OUTPUTS

GitHub.Project

NOTES

RELATED LINKS

PowerShellForGitHub

Docs

PowerShellForGitHub

Functions

Clone this wiki locally