spelling fixes (#165)
This commit is contained in:
Родитель
3fab72464e
Коммит
6735ba57a5
|
@ -301,14 +301,14 @@ Install-Module -Name Pester
|
|||
#### Configuring Your Environment
|
||||
The tests intentionally do not mock out interaction with the real GitHub API, as we want to know
|
||||
when our interaction with the API has been broken. That means that to execute the tests, you will
|
||||
need Administrator privelege for an account. For our purposes, we have a "test" account that our
|
||||
need Administrator privilege for an account. For our purposes, we have a "test" account that our
|
||||
team uses for having the tests [run automated](#automated-tests). For you to run the tests locally,
|
||||
you must make a couple changes:
|
||||
|
||||
1. Choose if you'll be executing the tests on your own pesonal account or your own test account
|
||||
1. Choose if you'll be executing the tests on your own personal account or your own test account
|
||||
(the tests should be non-destructive, but ... hey ... we are developing code here, mistakes happen.)
|
||||
2. Update your local copy of [tests/config/Settings.ps1](./tests/config/Settings.ps1) to note
|
||||
the `OwerName` and `OrganizationName` that the tests will be running under.
|
||||
the `OwnerName` and `OrganizationName` that the tests will be running under.
|
||||
> While you can certainly check-in this file to your own fork, please DO NOT include your
|
||||
> changes as part of any pull request that you may make. The `.gitignore` file tries
|
||||
> to help prevent that.
|
||||
|
@ -358,7 +358,7 @@ The [Azure DevOps pipeline](https://dev.azure.com/ms/PowerShellForGitHub/_build?
|
|||
has been [configured](https://github.com/microsoft/PowerShellForGitHub/blob/master/build/pipelines/templates/run-unitTests.yaml#L25-L28)
|
||||
to execute the tests against a test GitHub account (for the user `PowerShellForGitHubTeam`,
|
||||
and the org `PowerShellForGitHubTeamTestOrg`). You will see the AccessToken being referenced there
|
||||
as well...it is stored, encryted, within Azure DevOps. It is not accessible for use outside of
|
||||
as well...it is stored, encrypted, within Azure DevOps. It is not accessible for use outside of
|
||||
the CI pipeline. To run the tests locally with your own account, see
|
||||
[configuring-your-environment](#configuring-your-environment).
|
||||
|
||||
|
|
|
@ -35,7 +35,7 @@ function Group-GitHubIssue
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Weekly')]
|
||||
DefaultParameterSetName='Weekly')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param
|
||||
(
|
||||
|
@ -128,7 +128,7 @@ function Group-GitHubPullRequest
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Weekly')]
|
||||
DefaultParameterSetName='Weekly')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param
|
||||
(
|
||||
|
|
|
@ -33,13 +33,13 @@ function Get-GitHubAssignee
|
|||
If not supplied here, the DefaultNoStatus configuration property value will be used.
|
||||
|
||||
.EXAMPLE
|
||||
Get-GitHubAsigneeList -OwnerName Microsoft -RepositoryName PowerShellForGitHub
|
||||
Get-GitHubAssigneeList -OwnerName Microsoft -RepositoryName PowerShellForGitHub
|
||||
|
||||
Lists the available assignees for issues from the Microsoft\PowerShellForGitHub project.
|
||||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -125,7 +125,7 @@ function Test-GitHubAssignee
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[OutputType([bool])]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
|
@ -156,7 +156,7 @@ function Test-GitHubAssignee
|
|||
$telemetryProperties = @{
|
||||
'OwnerName' = (Get-PiiSafeString -PlainText $OwnerName)
|
||||
'RepositoryName' = (Get-PiiSafeString -PlainText $RepositoryName)
|
||||
'Asignee' = (Get-PiiSafeString -PlainText $Assignee)
|
||||
'Assignee' = (Get-PiiSafeString -PlainText $Assignee)
|
||||
}
|
||||
|
||||
$params = @{
|
||||
|
@ -226,7 +226,7 @@ function New-GithubAssignee
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -328,7 +328,7 @@ function Remove-GithubAssignee
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
|
|
@ -26,7 +26,7 @@ function Get-GitHubRepositoryBranch
|
|||
them individually.
|
||||
|
||||
.PARAMETER Name
|
||||
Name of the specific branch to be retieved. If not supplied, all branches will be retrieved.
|
||||
Name of the specific branch to be retrieved. If not supplied, all branches will be retrieved.
|
||||
|
||||
.PARAMETER AccessToken
|
||||
If provided, this will be used as the AccessToken for authentication with the
|
||||
|
@ -53,7 +53,7 @@ function Get-GitHubRepositoryBranch
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
[Alias('Get-GitHubBranch')]
|
||||
param(
|
||||
|
|
|
@ -62,7 +62,7 @@ function Get-GitHubComment
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='RepositoryElements')]
|
||||
DefaultParameterSetName='RepositoryElements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName='RepositoryElements')]
|
||||
|
@ -242,7 +242,7 @@ function New-GitHubComment
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -353,7 +353,7 @@ function Set-GitHubComment
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -453,7 +453,7 @@ function Remove-GitHubComment
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Alias('Delete-GitHubComment')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
|
|
|
@ -54,11 +54,11 @@ function Set-GitHubConfiguration
|
|||
<#
|
||||
.SYNOPSIS
|
||||
Change the value of a configuration property for the PowerShellForGitHub module,
|
||||
for the sesion only, or globally for this user.
|
||||
for the session only, or globally for this user.
|
||||
|
||||
.DESCRIPTION
|
||||
Change the value of a configuration property for the PowerShellForGitHub module,
|
||||
for the sesion only, or globally for this user.
|
||||
for the session only, or globally for this user.
|
||||
|
||||
A single call to this method can set any number or combination of properties.
|
||||
|
||||
|
@ -101,7 +101,7 @@ function Set-GitHubConfiguration
|
|||
data to telemetry (if telemetry hasn't been disabled via DisableTelemetry).
|
||||
|
||||
.PARAMETER DisableSmarterObjects
|
||||
By deffault, this module will modify all objects returned by the API calls to update
|
||||
By default, this module will modify all objects returned by the API calls to update
|
||||
any properties that can be converted to objects (like strings for Date/Time's being
|
||||
converted to real DateTime objects). Enable this property if you desire getting back
|
||||
the unmodified version of the object from the API.
|
||||
|
@ -481,7 +481,7 @@ function Reset-GitHubConfiguration
|
|||
.EXAMPLE
|
||||
Reset-GitHubConfiguration
|
||||
|
||||
Deletes the local configuration file and loads in all default configration values.
|
||||
Deletes the local configuration file and loads in all default configuration values.
|
||||
|
||||
.NOTES
|
||||
This command will not clear your authentication token. Please use Clear-GitHubAuthentication to accomplish that.
|
||||
|
@ -752,7 +752,7 @@ function Resolve-ParameterWithDefaultConfigurationValue
|
|||
The name of the parameter in BoundParameters.
|
||||
|
||||
.PARAMETER ConfigValueName
|
||||
The name of the cofiguration property that should be used as default if Name doesn't exist
|
||||
The name of the configuration property that should be used as default if Name doesn't exist
|
||||
in BoundParameters.
|
||||
|
||||
.PARAMETER NonEmptyStringRequired
|
||||
|
|
|
@ -62,7 +62,7 @@ function Get-GitHubContent
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName = 'Elements')]
|
||||
DefaultParameterSetName = 'Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification = "Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName = 'Elements')]
|
||||
|
|
|
@ -28,10 +28,10 @@ function Invoke-GHRestMethod
|
|||
|
||||
.PARAMETER UriFragment
|
||||
The unique, tail-end, of the REST URI that indicates what Store REST action will
|
||||
be peformed. This should not start with a leading "/".
|
||||
be performed. This should not start with a leading "/".
|
||||
|
||||
.PARAMETER Method
|
||||
The type of REST method being peformed. This only supports a reduced set of the
|
||||
The type of REST method being performed. This only supports a reduced set of the
|
||||
possible REST methods (delete, get, post, put).
|
||||
|
||||
.PARAMETER Description
|
||||
|
@ -77,7 +77,7 @@ function Invoke-GHRestMethod
|
|||
the background, enabling the command prompt to provide status information.
|
||||
|
||||
.OUTPUTS
|
||||
[PSCutomObject] - The result of the REST operation, in whatever form it comes in.
|
||||
[PSCustomObject] - The result of the REST operation, in whatever form it comes in.
|
||||
|
||||
.EXAMPLE
|
||||
Invoke-GHRestMethod -UriFragment "applications/" -Method Get -Description "Get first 10 applications"
|
||||
|
@ -543,7 +543,7 @@ function Invoke-GHRestMethodMultipleResult
|
|||
|
||||
.PARAMETER UriFragment
|
||||
The unique, tail-end, of the REST URI that indicates what Store REST action will
|
||||
be peformed. This should *not* include the 'top' and 'max' parameters. These
|
||||
be performed. This should *not* include the 'top' and 'max' parameters. These
|
||||
will be automatically added as needed.
|
||||
|
||||
.PARAMETER Description
|
||||
|
@ -576,7 +576,7 @@ function Invoke-GHRestMethodMultipleResult
|
|||
no bucket value will be used.
|
||||
|
||||
.PARAMETER SinglePage
|
||||
By default, this function will automtically call any follow-up "nextLinks" provided by
|
||||
By default, this function will automatically call any follow-up "nextLinks" provided by
|
||||
the return value in order to retrieve the entire result set. If this switch is provided,
|
||||
only the first "page" of results will be retrieved, and the "nextLink" links will not be
|
||||
followed.
|
||||
|
@ -588,7 +588,7 @@ function Invoke-GHRestMethodMultipleResult
|
|||
the background, enabling the command prompt to provide status information.
|
||||
|
||||
.OUTPUTS
|
||||
[PSCutomObject[]] - The result of the REST operation, in whatever form it comes in.
|
||||
[PSCustomObject[]] - The result of the REST operation, in whatever form it comes in.
|
||||
|
||||
.EXAMPLE
|
||||
Invoke-GHRestMethodMultipleResult -UriFragment "repos/PowerShell/PowerShellForGitHub/issues?state=all" -Description "Get all issues"
|
||||
|
@ -692,7 +692,7 @@ function Split-GitHubUri
|
|||
.DESCRIPTION
|
||||
Extracts the relevant elements of a GitHub repository Uri and returns the requested element.
|
||||
|
||||
Currently supports retrieving the OwnerName and the RepositoryName, when avaialable.
|
||||
Currently supports retrieving the OwnerName and the RepositoryName, when available.
|
||||
|
||||
The Git repo for this module can be found here: http://aka.ms/PowerShellForGitHub
|
||||
|
||||
|
@ -706,7 +706,7 @@ function Split-GitHubUri
|
|||
Returns the Repository Name from the Uri if it can be identified.
|
||||
|
||||
.OUTPUTS
|
||||
[PSCutomObject] - The OwnerName and RepositoryName elements from the provided URL
|
||||
[PSCustomObject] - The OwnerName and RepositoryName elements from the provided URL
|
||||
|
||||
.EXAMPLE
|
||||
Split-GitHubUri -Uri 'https://github.com/PowerShell/PowerShellForGitHub'
|
||||
|
@ -723,7 +723,7 @@ function Split-GitHubUri
|
|||
|
||||
PowerShell
|
||||
#>
|
||||
[CmdletBinding(DefaultParametersetName='RepositoryName')]
|
||||
[CmdletBinding(DefaultParameterSetName='RepositoryName')]
|
||||
param
|
||||
(
|
||||
[Parameter(Mandatory)]
|
||||
|
@ -788,7 +788,7 @@ function Resolve-RepositoryElements
|
|||
have no value.
|
||||
|
||||
.OUTPUTS
|
||||
[PSCutomObject] - The OwnerName and RepositoryName elements to be used
|
||||
[PSCustomObject] - The OwnerName and RepositoryName elements to be used
|
||||
#>
|
||||
[CmdletBinding(SupportsShouldProcess)]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
|
|
|
@ -45,7 +45,7 @@ function Get-GitHubEvent
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='RepositoryElements')]
|
||||
DefaultParameterSetName='RepositoryElements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName='RepositoryElements')]
|
||||
|
|
|
@ -33,7 +33,7 @@ function Get-GitHubIssue
|
|||
ownedAndMember: Retrieve issues across owned and member repositories
|
||||
|
||||
.PARAMETER Issue
|
||||
The number of specic Issue to retrieve. If not supplied, will return back all
|
||||
The number of specific Issue to retrieve. If not supplied, will return back all
|
||||
Issues for this Repository that match the specified criteria.
|
||||
|
||||
.PARAMETER IgnorePullRequests
|
||||
|
@ -117,7 +117,7 @@ function Get-GitHubIssue
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -376,7 +376,7 @@ function Get-GitHubIssueTimeline
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -456,7 +456,7 @@ function New-GitHubIssue
|
|||
Login(s) for Users to assign to the issue.
|
||||
|
||||
.PARAMETER Milestone
|
||||
The number of the mileston to associate this issue with.
|
||||
The number of the milestone to associate this issue with.
|
||||
|
||||
.PARAMETER Label
|
||||
Label(s) to associate with this issue.
|
||||
|
@ -484,7 +484,7 @@ function New-GitHubIssue
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -591,7 +591,7 @@ function Update-GitHubIssue
|
|||
Provide an empty array to clear all existing assignees.
|
||||
|
||||
.PARAMETER Milestone
|
||||
The number of the mileston to associate this issue with.
|
||||
The number of the milestone to associate this issue with.
|
||||
Set to 0/$null to remove current.
|
||||
|
||||
.PARAMETER Label
|
||||
|
@ -624,7 +624,7 @@ function Update-GitHubIssue
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -749,7 +749,7 @@ function Lock-GitHubIssue
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -859,7 +859,7 @@ function Unlock-GitHubIssue
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
|
|
@ -26,7 +26,7 @@ function Get-GitHubLabel
|
|||
them individually.
|
||||
|
||||
.PARAMETER Name
|
||||
Name of the specific label to be retieved. If not supplied, all labels will be retrieved.
|
||||
Name of the specific label to be retrieved. If not supplied, all labels will be retrieved.
|
||||
Emoji and codes are supported. For more information, see here: https://www.webpagefx.com/tools/emoji-cheat-sheet/
|
||||
|
||||
.PARAMETER Issue
|
||||
|
@ -58,7 +58,7 @@ function Get-GitHubLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName='Elements')]
|
||||
|
@ -204,7 +204,7 @@ function New-GitHubLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -318,7 +318,7 @@ function Remove-GitHubLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
[Alias('Delete-GitHubLabel')]
|
||||
param(
|
||||
|
@ -424,7 +424,7 @@ function Update-GitHubLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -537,7 +537,7 @@ function Set-GitHubLabel
|
|||
This method does not rename any existing labels, as it doesn't have any context regarding
|
||||
which Issue the new name is for. Therefore, it is possible that by running this function
|
||||
on a repository with Issues that have already been assigned Labels, you may experience data
|
||||
loss as a minor correction to you (maye fixing a typo) will result in the old Label being
|
||||
loss as a minor correction to you (maybe fixing a typo) will result in the old Label being
|
||||
removed (and thus unassigned from existing Issues) and then the new one created.
|
||||
|
||||
.EXAMPLE
|
||||
|
@ -549,7 +549,7 @@ function Set-GitHubLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -660,7 +660,7 @@ function Add-GitHubIssueLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName='Elements')]
|
||||
|
@ -761,7 +761,7 @@ function Set-GitHubIssueLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -863,7 +863,7 @@ function Remove-GitHubIssueLabel
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
[Alias('Delete-GitHubLabel')]
|
||||
param(
|
||||
|
|
|
@ -58,7 +58,7 @@ function Get-GitHubMilestone
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='RepositoryElements')]
|
||||
DefaultParameterSetName='RepositoryElements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName='MilestoneElements')]
|
||||
|
@ -226,7 +226,7 @@ function New-GitHubMilestone
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName='Elements')]
|
||||
|
@ -375,7 +375,7 @@ function Set-GitHubMilestone
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(Mandatory, ParameterSetName='Elements')]
|
||||
|
@ -503,7 +503,7 @@ function Remove-GitHubMilestone
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Alias('Delete-GitHubMilestone')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
|
|
|
@ -389,7 +389,7 @@ function Get-GitHubCodeOfConduct
|
|||
.EXAMPLE
|
||||
Get-GitHubCodeOfConduct -OwnerName Microsoft -RepositoryName PowerShellForGitHub
|
||||
|
||||
Gets the content of the Code of Coduct file for the Microsoft\PowerShellForGitHub repository
|
||||
Gets the content of the Code of Conduct file for the Microsoft\PowerShellForGitHub repository
|
||||
if one is detected.
|
||||
|
||||
It may be necessary to convert the content of the file. Check the 'encoding' property of
|
||||
|
|
|
@ -26,7 +26,7 @@ function Get-GitHubPullRequest
|
|||
them individually.
|
||||
|
||||
.PARAMETER PullRequest
|
||||
The specic pull request id to return back. If not supplied, will return back all
|
||||
The specific pull request id to return back. If not supplied, will return back all
|
||||
pull requests for the specified Repository.
|
||||
|
||||
.PARAMETER State
|
||||
|
@ -69,7 +69,7 @@ function Get-GitHubPullRequest
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
|
|
@ -83,7 +83,7 @@ function Get-GitHubRelease
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(
|
||||
|
|
|
@ -220,7 +220,7 @@ function Remove-GitHubRepository
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Alias('Delete-GitHubRepository')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
|
@ -351,7 +351,7 @@ function Get-GitHubRepository
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -514,7 +514,7 @@ function Rename-GitHubRepository
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Uri',
|
||||
DefaultParameterSetName='Uri',
|
||||
ConfirmImpact="High")]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
|
@ -652,7 +652,7 @@ function Update-GitHubRepository
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -776,7 +776,7 @@ function Get-GitHubRepositoryTopic
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -868,7 +868,7 @@ function Set-GitHubRepositoryTopic
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='ElementsName')]
|
||||
DefaultParameterSetName='ElementsName')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='ElementsName')]
|
||||
|
@ -1001,7 +1001,7 @@ function Get-GitHubRepositoryContributor
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -1100,7 +1100,7 @@ function Get-GitHubRepositoryCollaborator
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -1188,7 +1188,7 @@ function Get-GitHubRepositoryLanguage
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -1272,7 +1272,7 @@ function Get-GitHubRepositoryTag
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -1360,7 +1360,7 @@ function Move-GitHubRepositoryOwnership
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Alias('Transfer-GitHubRepositoryOwnership')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
|
|
|
@ -45,7 +45,7 @@ function Get-GitHubRepositoryFork
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -145,7 +145,7 @@ function New-GitHubRepositoryFork
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
|
|
@ -42,7 +42,7 @@ function Get-GitHubReferrerTraffic
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -126,7 +126,7 @@ function Get-GitHubPathTraffic
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -214,7 +214,7 @@ function Get-GitHubViewTraffic
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -306,7 +306,7 @@ function Get-GitHubCloneTraffic
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
|
|
@ -29,7 +29,7 @@ function Get-GitHubTeam
|
|||
The name of the organization
|
||||
|
||||
.PARAMETER TeamId
|
||||
The ID of the speific team to retrieve
|
||||
The ID of the specific team to retrieve
|
||||
|
||||
.PARAMETER AccessToken
|
||||
If provided, this will be used as the AccessToken for authentication with the
|
||||
|
@ -50,7 +50,7 @@ function Get-GitHubTeam
|
|||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='Elements')]
|
||||
DefaultParameterSetName='Elements')]
|
||||
param
|
||||
(
|
||||
[Parameter(ParameterSetName='Elements')]
|
||||
|
@ -104,7 +104,7 @@ function Get-GitHubTeam
|
|||
$telemetryProperties['OrganizationName'] = Get-PiiSafeString -PlainText $OrganizationName
|
||||
|
||||
$uriFragment = "/orgs/$OrganizationName/teams"
|
||||
$description = "Gettings teams in $OrganizationName"
|
||||
$description = "Getting teams in $OrganizationName"
|
||||
}
|
||||
else
|
||||
{
|
||||
|
@ -166,7 +166,7 @@ function Get-GitHubTeamMember
|
|||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='ID')]
|
||||
DefaultParameterSetName='ID')]
|
||||
param
|
||||
(
|
||||
[Parameter(Mandatory)]
|
||||
|
|
|
@ -55,7 +55,7 @@ function Get-GitHubUser
|
|||
#>
|
||||
[CmdletBinding(
|
||||
SupportsShouldProcess,
|
||||
DefaultParametersetName='ListAndSearch')]
|
||||
DefaultParameterSetName='ListAndSearch')]
|
||||
[Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSShouldProcess", "", Justification="Methods called within here make use of PSShouldProcess, and the switch is passed on to them inherently.")]
|
||||
param(
|
||||
[Parameter(ParameterSetName='ListAndSearch')]
|
||||
|
|
|
@ -323,7 +323,7 @@ function Write-Log
|
|||
}
|
||||
|
||||
# Write the message to screen/log.
|
||||
# Note that the below logic could easily be moved to a separate helper function, but a concious
|
||||
# Note that the below logic could easily be moved to a separate helper function, but a conscious
|
||||
# decision was made to leave it here. When this cmdlet is called with -Level Error, Write-Error
|
||||
# will generate a WriteErrorException with the origin being Write-Log. If this call is moved to
|
||||
# a helper function, the origin of the WriteErrorException will be the helper function, which
|
||||
|
@ -433,7 +433,7 @@ function Write-InvocationLog
|
|||
be in JSON format as opposed to PowerShell format. However, it should be sufficient enough
|
||||
for debugging purposes.
|
||||
|
||||
ExcludeParamater will always take precedence over RedactParameter.
|
||||
ExcludeParameter will always take precedence over RedactParameter.
|
||||
#>
|
||||
[CmdletBinding(SupportsShouldProcess)]
|
||||
param(
|
||||
|
@ -725,7 +725,7 @@ function Get-HttpWebResponseContent
|
|||
Invoke-WebRequest, it returns back a BasicHtmlWebResponseObject which
|
||||
directly contains a Content property, however if the web request fails,
|
||||
you get a WebException which contains a simpler WebResponse, which
|
||||
requires a bit more effort in order to acccess the raw response content.
|
||||
requires a bit more effort in order to access the raw response content.
|
||||
|
||||
.PARAMETER WebResponse
|
||||
An HttpWebResponse object, typically the Response property on a WebException.
|
||||
|
|
|
@ -24,7 +24,7 @@ function Get-PiiSafeString
|
|||
.EXAMPLE
|
||||
Get-PiiSafeString -PlainText "Hello World"
|
||||
|
||||
Returns back the string "B10A8DB164E0754105B7A99BE72E3FE5" which respresents
|
||||
Returns back the string "B10A8DB164E0754105B7A99BE72E3FE5" which represents
|
||||
the SHA512 hash of "Hello World", but only if the "DisablePiiProtection" configuration
|
||||
value is $false. If it's $true, "Hello World" will be returned.
|
||||
|
||||
|
@ -245,7 +245,7 @@ function Get-TelemetryClient
|
|||
Returns back the singleton instance of the Application Insights TelemetryClient for
|
||||
this module.
|
||||
|
||||
If the singleton hasn't been initialized yet, this will ensure all dependenty assemblies
|
||||
If the singleton hasn't been initialized yet, this will ensure all dependent assemblies
|
||||
are available on the machine, create the client and initialize its properties.
|
||||
|
||||
This will first look for the dependent assemblies in the module's script directory.
|
||||
|
|
|
@ -76,7 +76,7 @@ try
|
|||
$repo1 = New-GitHubRepository -RepositoryName ([Guid]::NewGuid().Guid) -AutoInit
|
||||
$repo2 = New-GitHubRepository -RepositoryName ([Guid]::NewGuid().Guid) -AutoInit
|
||||
|
||||
Context 'When no addional conditions specified' {
|
||||
Context 'When no additional conditions specified' {
|
||||
for ($i = 0; $i -lt 3; $i++)
|
||||
{
|
||||
$null = New-GitHubIssue -OwnerName $script:ownerName -RepositoryName $repo1.name -Title ([guid]::NewGuid().Guid)
|
||||
|
@ -107,7 +107,7 @@ try
|
|||
# required state for testing, and to recover back to the original state at the conclusion of the test.
|
||||
|
||||
# Describe 'Obtaining pull requests for repository' {
|
||||
# Context 'When no addional conditions specified' {
|
||||
# Context 'When no additional conditions specified' {
|
||||
# $pullRequests = Get-GitHubPullRequest -Uri $script:repositoryUrl
|
||||
|
||||
# It 'Should return expected number of PRs' {
|
||||
|
@ -128,7 +128,7 @@ try
|
|||
# }
|
||||
|
||||
# Describe 'Obtaining repository with biggest number of pull requests' {
|
||||
# Context 'When no addional conditions specified' {
|
||||
# Context 'When no additional conditions specified' {
|
||||
# @($script:repositoryUrl, $script:repositoryUrl2) |
|
||||
# ForEach-Object {
|
||||
# $pullRequestCounts += ([PSCustomObject]@{
|
||||
|
|
Загрузка…
Ссылка в новой задаче