< Back
Update-GitHubRepository
Post
NAME Update-GitHubRepository
SYNOPSIS
Updates the details of an existing repository on GitHub.
SYNTAX
Update-GitHubRepository [-OwnerName <String>] [-RepositoryName <String>] [-Description <String>] [-Homepage
<String>] [-DefaultBranch <String>] [-Private] [-NoIssues] [-NoProjects] [-NoWiki] [-DisallowSquashMerge]
[-DisallowMergeCommit] [-DisallowRebaseMerge] [-Archived] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Update-GitHubRepository -Uri <String> [-Description <String>] [-Homepage <String>] [-DefaultBranch <String>]
[-Private] [-NoIssues] [-NoProjects] [-NoWiki] [-DisallowSquashMerge] [-DisallowMergeCommit]
[-DisallowRebaseMerge] [-Archived] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates the details of an existing repository on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
PARAMETERS
-OwnerName <String>
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RepositoryName <String>
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Uri <String>
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A short description of the repository.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Homepage <String>
A URL with more information about the repository.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultBranch <String>
Update the default branch for this repository.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Private [<SwitchParameter>]
Specify this to make the repository repository. Creating private repositories requires a
paid GitHub account.
To change a repository to be public, specify -Private:$false
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoIssues [<SwitchParameter>]
By default, this repository will support Issues. Specify this to disable Issues.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoProjects [<SwitchParameter>]
By default, this repository will support Projects. Specify this to disable Projects.
If you're creating a repository in an organization that has disabled repository projects,
this will be true by default.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoWiki [<SwitchParameter>]
By default, this repository will have a Wiki. Specify this to disable the Wiki.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisallowSquashMerge [<SwitchParameter>]
By default, squash-merging pull requests will be allowed.
Specify this to disallow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisallowMergeCommit [<SwitchParameter>]
By default, merging pull requests with a merge commit will be allowed.
Specify this to disallow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisallowRebaseMerge [<SwitchParameter>]
By default, rebase-merge pull requests will be allowed.
Specify this to disallow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Archived [<SwitchParameter>]
Specify this to archive this repository.
NOTE: You cannot unarchive repositories through the API / this module.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AccessToken <String>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NoStatus [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Update-GitHubRepository -OwnerName Microsoft -RepositoryName PowerShellForGitHub -Description 'The best way
to automate your GitHub interactions'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Update-GitHubRepository -Uri https://github.com/PowerShell/PowerShellForGitHub -Private:$false
RELATED LINKS
SYNOPSIS
Updates the details of an existing repository on GitHub.
SYNTAX
Update-GitHubRepository [-OwnerName <String>] [-RepositoryName <String>] [-Description <String>] [-Homepage
<String>] [-DefaultBranch <String>] [-Private] [-NoIssues] [-NoProjects] [-NoWiki] [-DisallowSquashMerge]
[-DisallowMergeCommit] [-DisallowRebaseMerge] [-Archived] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm]
[<CommonParameters>]
Update-GitHubRepository -Uri <String> [-Description <String>] [-Homepage <String>] [-DefaultBranch <String>]
[-Private] [-NoIssues] [-NoProjects] [-NoWiki] [-DisallowSquashMerge] [-DisallowMergeCommit]
[-DisallowRebaseMerge] [-Archived] [-AccessToken <String>] [-NoStatus] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Updates the details of an existing repository on GitHub.
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
PARAMETERS
-OwnerName <String>
Owner of the repository.
If not supplied here, the DefaultOwnerName configuration property value will be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-RepositoryName <String>
Name of the repository.
If not supplied here, the DefaultRepositoryName configuration property value will be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Uri <String>
Uri for the repository.
The OwnerName and RepositoryName will be extracted from here instead of needing to provide
them individually.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Description <String>
A short description of the repository.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Homepage <String>
A URL with more information about the repository.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-DefaultBranch <String>
Update the default branch for this repository.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Private [<SwitchParameter>]
Specify this to make the repository repository. Creating private repositories requires a
paid GitHub account.
To change a repository to be public, specify -Private:$false
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoIssues [<SwitchParameter>]
By default, this repository will support Issues. Specify this to disable Issues.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoProjects [<SwitchParameter>]
By default, this repository will support Projects. Specify this to disable Projects.
If you're creating a repository in an organization that has disabled repository projects,
this will be true by default.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-NoWiki [<SwitchParameter>]
By default, this repository will have a Wiki. Specify this to disable the Wiki.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisallowSquashMerge [<SwitchParameter>]
By default, squash-merging pull requests will be allowed.
Specify this to disallow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisallowMergeCommit [<SwitchParameter>]
By default, merging pull requests with a merge commit will be allowed.
Specify this to disallow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-DisallowRebaseMerge [<SwitchParameter>]
By default, rebase-merge pull requests will be allowed.
Specify this to disallow.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Archived [<SwitchParameter>]
Specify this to archive this repository.
NOTE: You cannot unarchive repositories through the API / this module.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-AccessToken <String>
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.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-NoStatus [<SwitchParameter>]
If 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.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Update-GitHubRepository -OwnerName Microsoft -RepositoryName PowerShellForGitHub -Description 'The best way
to automate your GitHub interactions'
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Update-GitHubRepository -Uri https://github.com/PowerShell/PowerShellForGitHub -Private:$false
RELATED LINKS