Functions/Public/Update-GitHubRepository.ps1
|
function Update-GitHubRepository { <# .Synopsis Updates the details for an existing GitHub repository. .Description This function updates the details for an existing GitHub repository. The parameters on this function enable you to update the repository's attributes including: - Name - Description - Project Page URI (Home Page) - Enable or Disable the Issue Tracker for this Repository - Switch the GitHub Repository between private and public access GitHub REST API documentation: https://developer.github.com/v3/repos .Parameter Owner The GitHub username of the account that owns the target repository. .Parameter Name The name of the existing GitHub Repository that will be operated on. .Parameter NewName This parameter allows you to specify a new name for the GitHub repository. .Parameter Description The new description that you'd like to set for the GitHub Repository. This will replace any existing description. .Parameter Homepage The URI to the project's home page. This will replace any existing value for the project home page. .Parameter DisableIssues This boolean parameter enables ($false) or disables ($true) the Issue Tracker for the GitHub Repository. .Parameter Private This boolean parameter makes the GitHub Repository public ($false) or private ($true). .Notes Created by Trevor Sullivan <trevor@trevorsullivan.net> #> param ( [Parameter(Mandatory)] [string] $Owner, [Parameter(Mandatory)] [string] $Name, [string] $NewName, [string] $Description, [string] $Homepage, [Boolean] $DisableIssues, [Boolean] $Private, # Optional base URL of the GitHub API, for example "https://ghe.mycompany.com/api/v3/" (including the trailing slash). # Defaults to "https://api.github.com" [Uri] $BaseUri = [Uri]::new('https://api.github.com'), [Security.SecureString] $Token = (Get-GitHubToken) ) $Body = @{ name = if ($NewName) { $NewName } else { $Name }; description = $Description; homepage = $Homepage; private = [bool]$Private; has_issues = [bool]!$DisableIssues; auto_init = [bool]$IncludeReadme; } | ConvertTo-Json; Write-Verbose -Message $Body; $ApiCall = @{ Uri = 'repos/{0}/{1}' -f $Owner, $Name; Body = $Body; Method = 'Patch'; Token = $Token BaseUri = $BaseUri } Invoke-GitHubApi @ApiCall; } Export-ModuleMember -Alias ( New-Alias -Name Set-GitHubRepository -Value Update-GitHubRepository -PassThru ) |