From 5bd31f2e463aeba5778b3dd24e6e05047dc6ae0d Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 15:21:19 +0200 Subject: [PATCH 01/16] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20Linter=20?= =?UTF-8?q?environment=20variables=20for=20validation=20checks=20in=20PSMo?= =?UTF-8?q?dule.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/PSModule.yml | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/.github/PSModule.yml b/.github/PSModule.yml index 9a91761c3..fddedd5f7 100644 --- a/.github/PSModule.yml +++ b/.github/PSModule.yml @@ -19,3 +19,12 @@ Test: # Build: # Docs: # Skip: true +Linter: + env: + VALIDATE_BIOME_FORMAT: false + VALIDATE_BIOME_LINT: false + VALIDATE_GITHUB_ACTIONS_ZIZMOR: false + VALIDATE_JSCPD: false + VALIDATE_JSON_PRETTIER: false + VALIDATE_MARKDOWN_PRETTIER: false + VALIDATE_YAML_PRETTIER: false From 4bb946ae178eeb72e65080f8e29e18e16e1de5ca Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 16:15:13 +0200 Subject: [PATCH 02/16] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20VALIDATE?= =?UTF-8?q?=5FPOWERSHELL=20option=20to=20Linter=20environment=20variables?= =?UTF-8?q?=20in=20PSModule.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/PSModule.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PSModule.yml b/.github/PSModule.yml index fddedd5f7..4f6db3a65 100644 --- a/.github/PSModule.yml +++ b/.github/PSModule.yml @@ -28,3 +28,4 @@ Linter: VALIDATE_JSON_PRETTIER: false VALIDATE_MARKDOWN_PRETTIER: false VALIDATE_YAML_PRETTIER: false + VALIDATE_POWERSHELL: false From 3c1dfdc6c7c909fb831e4baee4a0e4206752cbf9 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 6 Oct 2025 22:37:30 +0200 Subject: [PATCH 03/16] Fix Docs --- .github/PSModule.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/PSModule.yml b/.github/PSModule.yml index 4f6db3a65..0d130b7e0 100644 --- a/.github/PSModule.yml +++ b/.github/PSModule.yml @@ -19,6 +19,7 @@ Test: # Build: # Docs: # Skip: true + Linter: env: VALIDATE_BIOME_FORMAT: false From 9e90d3c5197d40d6e54de82350309a5da2aee254 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Wed, 8 Oct 2025 11:44:26 +0200 Subject: [PATCH 04/16] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Clean=20up=20co?= =?UTF-8?q?mments=20in=20.markdown-lint.yml=20for=20better=20readability?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/linters/.markdown-lint.yml | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/linters/.markdown-lint.yml b/.github/linters/.markdown-lint.yml index 5b21b4a03..57db57e64 100644 --- a/.github/linters/.markdown-lint.yml +++ b/.github/linters/.markdown-lint.yml @@ -8,19 +8,19 @@ ############### # Rules by id # ############### -MD004: false # Unordered list style +MD004: false # Unordered list style MD007: - indent: 2 # Unordered list indentation + indent: 2 # Unordered list indentation MD013: - line_length: 808 # Line length -MD024: false # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item + line_length: 808 # Line length +MD024: false # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item MD026: - punctuation: ".,;:!。，；:" # List of not allowed -MD029: false # Ordered list item prefix -MD033: false # Allow inline HTML -MD036: false # Emphasis used instead of a heading + punctuation: '.,;:!。，；:' # List of not allowed +MD029: false # Ordered list item prefix +MD033: false # Allow inline HTML +MD036: false # Emphasis used instead of a heading ################# # Rules by tags # ################# -blank_lines: false # Error on blank lines +blank_lines: false # Error on blank lines From 557191945369ba45c4050644225d8307c75066fe Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 10:40:22 +0200 Subject: [PATCH 05/16] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Enhance=20docum?= =?UTF-8?q?entation=20for=20Start-GitHubLogGroup=20and=20Stop-GitHubLogGro?= =?UTF-8?q?up=20functions;=20add=20detailed=20descriptions=20and=20example?= =?UTF-8?q?s?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../public/Commands/Start-GitHubLogGroup.ps1 | 36 ++++++++++++++++--- .../public/Commands/Stop-GitHubLogGroup.ps1 | 31 +++++++++++++--- .../Workflows/Enable-GitHubWorkflow.ps1 | 17 +++++++++ 3 files changed, 75 insertions(+), 9 deletions(-) diff --git a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 index a7e722f7d..8c786b75b 100644 --- a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 @@ -3,16 +3,41 @@ .SYNOPSIS Starts a log group in GitHub Actions + .DESCRIPTION + Creates an expandable group in the GitHub Actions log. Anything you print to the log between the + `Start-GitHubLogGroup` and `Stop-GitHubLogGroup` commands will be nested inside an expandable entry in the log. + This is useful for organizing long log outputs and making them more readable. + + This function only has an effect when running in a GitHub Actions workflow (when $env:GITHUB_ACTIONS is 'true'). + When run outside of GitHub Actions, it does nothing. + + This corresponds to the `::group::{title}` workflow command in GitHub Actions. + .EXAMPLE - New-LogGroup 'MyGroup' + ```pwsh + Start-GitHubLogGroup 'MyGroup' + ``` - Starts a new log group named 'MyGroup' + Starts a new log group named 'MyGroup'. All subsequent log output will be grouped under this expandable section + until Stop-GitHubLogGroup is called. - .NOTES - [GitHub - Grouping log lines](https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines) + .EXAMPLE + ```pwsh + Start-GitHubLogGroup 'Building application' + Write-Host 'Step 1: Restoring packages' + Write-Host 'Step 2: Compiling code' + Write-Host 'Step 3: Running tests' + Stop-GitHubLogGroup + ``` + + Creates a collapsible log group containing the build steps. The output will appear nested under the + "Building application" header in the GitHub Actions log. .LINK https://psmodule.io/GitHub/Functions/Commands/Start-GitHubLogGroup + + .NOTES + [Workflow commands](https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines) #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function', @@ -25,7 +50,8 @@ [CmdletBinding()] [Alias('Start-LogGroup')] param( - # The name of the log group + # The title of the log group. + # This will be displayed as the header of the expandable group in the GitHub Actions log. [Parameter(Mandatory)] [string] $Name ) diff --git a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 index 7e185271f..b041b2336 100644 --- a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 @@ -3,16 +3,39 @@ .SYNOPSIS Stops the current log group in GitHub Actions + .DESCRIPTION + Ends the expandable group in the GitHub Actions log that was started with `Start-GitHubLogGroup`. + All log output after this command will no longer be nested within the group. + + This function only has an effect when running in a GitHub Actions workflow (when $env:GITHUB_ACTIONS is 'true'). + When run outside of GitHub Actions, it does nothing. + + This corresponds to the `::endgroup::` workflow command in GitHub Actions. + .EXAMPLE - Stop-LogGroup + ```pwsh + Stop-GitHubLogGroup + ``` - Starts a new log group named 'MyGroup' + Stops the current log group in GitHub Actions. - .NOTES - [GitHub - Grouping log lines](https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines) + .EXAMPLE + ```pwsh + Start-GitHubLogGroup 'Deployment Steps' + Write-Host 'Deploying to staging...' + Write-Host 'Deployment complete' + Stop-GitHubLogGroup + Write-Host 'This output is not in the group' + ``` + + Creates a log group for deployment steps. The final Write-Host command outputs text outside of the group + since Stop-GitHubLogGroup was called. .LINK https://psmodule.io/GitHub/Functions/Commands/Stop-GitHubLogGroup + + .NOTES + [Workflow commands](https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines) #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Scope = 'Function', diff --git a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 index 49d9b4c41..679c92ea3 100644 --- a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 @@ -1,10 +1,27 @@ filter Enable-GitHubWorkflow { <# .SYNOPSIS + Enable a workflow .DESCRIPTION + Enables a workflow and sets the `state` of the workflow to `active`. You can use workflow + file name and ID in the `ID` parameter. For example, you could use `main.yaml`. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh + Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 'main.yaml' + ``` + + Enables the workflow with the file name 'main.yaml' in the PSModule/GitHub repository. + + .EXAMPLE + ```pwsh + Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 161335 + ``` + + Enables the workflow with the ID 161335 in the PSModule/GitHub repository. .INPUTS GitHubWorkflow From e561045fd933c6c3e9d3870ae5d922bbbe9a508a Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 11:28:32 +0200 Subject: [PATCH 06/16] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Add=20PowerShel?= =?UTF-8?q?l=20code=20examples=20to=20documentation=20for=20various=20GitH?= =?UTF-8?q?ub=20functions=20to=20enhance=20usability=20and=20clarity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Members/New-GitHubOrganizationInvitation.ps1 | 4 ++++ .../Remove-GitHubOrganizationInvitation.ps1 | 2 ++ .../public/Organization/New-GitHubOrganization.ps1 | 2 ++ .../Repositories/Update-GitHubRepository.ps1 | 6 ++++++ .../public/Users/Emails/Add-GitHubUserEmail.ps1 | 2 ++ .../public/Users/Emails/Remove-GitHubUserEmail.ps1 | 2 ++ .../Users/Social-Accounts/Add-GitHubUserSocial.ps1 | 2 ++ .../Social-Accounts/Remove-GitHubUserSocial.ps1 | 5 ++--- .../Update-GitHubAppWebhookConfiguration.ps1 | 2 ++ tools/utilities/New-Function.ps1 | 14 +++++++------- 10 files changed, 31 insertions(+), 10 deletions(-) diff --git a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 index b1fb3633a..6094fd6ac 100644 --- a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 @@ -13,12 +13,16 @@ and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." .EXAMPLE + ```pwsh New-GitHubOrganizationInvitation -Organization 'PSModule' -InviteeID 123456789 -Role 'admin' + ``` Invites the user with the ID `12345679` to the organization `PSModule` with the role `admin`. .EXAMPLE + ```pwsh New-GitHubOrganizationInvitation -Organization 'PSModule' -Email 'user@psmodule.io' + ``` Invites the user with the email `user@psmodule.io` to the organization `PSModule`. diff --git a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 index 2b3192f3c..5751c243d 100644 --- a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 @@ -9,7 +9,9 @@ This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). .EXAMPLE + ```pwsh Remove-GitHubOrganizationInvitation -Organization 'github' -InvitationID '12345678' + ``` Cancel the invitation with the ID '12345678' for the organization `github`. diff --git a/src/functions/public/Organization/New-GitHubOrganization.ps1 b/src/functions/public/Organization/New-GitHubOrganization.ps1 index 7279e9358..d8412b060 100644 --- a/src/functions/public/Organization/New-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/New-GitHubOrganization.ps1 @@ -7,7 +7,9 @@ This function creates a new GitHub organization within the specified enterprise. .EXAMPLE + ```pwsh New-GitHubOrganization -Enterprise 'my-enterprise' -Name 'my-org' -Owner 'user1' -BillingEmail 'billing@example.com' + ``` .OUTPUTS GitHubOrganization diff --git a/src/functions/public/Repositories/Update-GitHubRepository.ps1 b/src/functions/public/Repositories/Update-GitHubRepository.ps1 index 615c1bb29..49a2ea15e 100644 --- a/src/functions/public/Repositories/Update-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Update-GitHubRepository.ps1 @@ -8,9 +8,12 @@ [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. .EXAMPLE + ```pwsh Update-GitHubRepository -Name 'octocat' -Description 'Hello-World' -Homepage 'https://github.com' + ``` .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Name = 'Hello-World' @@ -19,6 +22,9 @@ Homepage = 'https://github.com' } Update-GitHubRepository @params + ``` + + Updates the repository `Hello-World` owned by `octocat` with a new name, description, and homepage URL. .INPUTS GitHubRepository diff --git a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 index 1ee277e8d..7c89e63ae 100644 --- a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 @@ -7,7 +7,9 @@ This endpoint is accessible with the `user` scope. .EXAMPLE + ```pwsh Add-GitHubUserEmail -Email 'octocat@github.com','firstname.lastname@work.com' + ``` Adds the email addresses `octocat@github.com` and `firstname.lastname@work.com` to the authenticated user's account. diff --git a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 index 2a7ed95ec..4e81fdfa5 100644 --- a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 @@ -7,7 +7,9 @@ This endpoint is accessible with the `user` scope. .EXAMPLE + ```pwsh Remove-GitHubUserEmail -Emails 'octocat@github.com','firstname.lastname@work.com' + ``` Removes the email addresses `octocat@github.com` and `firstname.lastname@work.com` from the authenticated user's account. diff --git a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 index 3dda88403..879f6e770 100644 --- a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 @@ -7,7 +7,9 @@ Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. .EXAMPLE + ```pwsh Add-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount', 'https://www.linkedin.com/company/MyCompany' + ``` Adds the Twitter and LinkedIn accounts to the authenticated user's profile. diff --git a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 index eaaa15fa6..8b85a69c4 100644 --- a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 @@ -6,11 +6,10 @@ .DESCRIPTION Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. - .PARAMETER AccountUrls - Parameter description - .EXAMPLE + ```pwsh Remove-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount' + ``` .NOTES [Delete social accounts for the authenticated user](https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user) diff --git a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 index 1560ada7c..a92f69ddb 100644 --- a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 @@ -11,7 +11,9 @@ to access this endpoint. .EXAMPLE + ```pwsh Update-GitHubAppWebhookConfiguration -URL 'https://example.com' -ContentType 'json' -Secret 'mysecret' -EnableSsl + ``` Output: ```powershell diff --git a/tools/utilities/New-Function.ps1 b/tools/utilities/New-Function.ps1 index 8c1955e05..02ce6c3ec 100644 --- a/tools/utilities/New-Function.ps1 +++ b/tools/utilities/New-Function.ps1 @@ -6,13 +6,11 @@ .DESCRIPTION Long description - .PARAMETER Path - Parameter description - - .PARAMETER Method - Parameter description - .EXAMPLE + ```pwsh + New-Function -Path '/user/emails' -Method 'POST' + ``` + An example .NOTES @@ -20,9 +18,11 @@ #> [CmdletBinding(SupportsShouldProcess)] param( + # Parameter description [Parameter(Mandatory)] [string] $Path, + # Parameter description [Parameter(Mandatory)] [string] $Method ) @@ -35,7 +35,7 @@ $response.paths.$Path.$Method - $FunctionName = "$Method-GitHub" + (($response.paths.$path.$method.operationId) -Replace '/', '-') + $FunctionName = "$Method-GitHub" + (($response.paths.$path.$method.operationId) -replace '/', '-') $folderName = $response.paths.$path.$method.'x-github'.category $subFolderName = $response.paths.$path.$method.'x-github'.subcategory From c07103aadbef04f6fed462d4815f7b31a0c3c76a Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 11:50:14 +0200 Subject: [PATCH 07/16] Enhance PowerShell function documentation with code examples - Added code examples in the documentation for various GitHub user key management functions including: - Remove-GitHubUserKey - Add-GitHubUserSigningKey - Get-GitHubUserSigningKey - Remove-GitHubUserSigningKey - Add-GitHubUserSocial - Remove-GitHubUserSocial - Update-GitHubUser - Export-GitHubVariable - Get-GitHubVariable - New-GitHubVariable - Remove-GitHubVariable - Add-GitHubVariableSelectedRepository - Get-GitHubVariableSelectedRepository - Remove-GitHubVariableSelectedRepository - Set-GitHubVariableSelectedRepository - Set-GitHubVariable - Update-GitHubVariable - Get-GitHubAppWebhookConfiguration - Get-GitHubAppWebhookDelivery - Invoke-GitHubAppWebhookReDelivery - Test-GitHubWebhookSignature - Update-GitHubAppWebhookConfiguration - Disable-GitHubWorkflow - Enable-GitHubWorkflow - Get-GitHubWorkflow - Get-GitHubWorkflowRun - Remove-GitHubWorkflowRun - Restart-GitHubWorkflowRun - Stop-GitHubWorkflowRun - Start-GitHubWorkflow - New-FunctionTemplate - Removed invisible characters from function definitions to ensure compatibility. --- .../Actions/Import-GitHubEventData.ps1 | 4 ++- .../Actions/Import-GitHubRunnerData.ps1 | 4 ++- .../Get-GitHubWorkflowRunByRepo.ps1 | 6 ++++- .../Get-GitHubWorkflowRunByWorkflow.ps1 | 6 ++++- .../Add-GitHubKeyVaultJWTSignature.ps1 | 6 +++-- .../Add-GitHubLocalJWTSignature.ps1 | 4 ++- .../Get-GitHubAppAsAuthenticatedApp.ps1 | 4 ++- .../Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 | 4 ++- .../Get-GitHubAppInstallableOrganization.ps1 | 4 ++- ...pInstallationForAuthenticatedAppAsList.ps1 | 4 ++- ...AppInstallationForAuthenticatedAppByID.ps1 | 4 ++- ...pInstallationForEnterpriseOrganization.ps1 | 4 ++- ...t-GitHubAppInstallationForOrganization.ps1 | 4 ++- ...tall-GitHubAppOnEnterpriseOrganization.ps1 | 4 ++- .../GitHub Apps/New-GitHubUnsignedJWT.ps1 | 4 ++- .../Test-GitHubJWTRefreshRequired.ps1 | 2 ++ .../GitHub Apps/Uninstall-GitHubAppAsApp.ps1 | 2 ++ ...tall-GitHubAppOnEnterpriseOrganization.ps1 | 4 ++- .../Apps/GitHub Apps/Update-GitHubAppJWT.ps1 | 8 +++++- .../Artifacts/Get-GitHubArtifactById.ps1 | 6 +++-- .../Get-GitHubArtifactFromRepository.ps1 | 6 +++-- .../Get-GitHubArtifactFromWorkflowRun.ps1 | 6 +++-- .../private/Auth/Cli/Connect-GithubCli.ps1 | 6 +++-- .../Auth/Context/Assert-GitHubContext.ps1 | 4 ++- .../Auth/Context/Remove-GitHubContext.ps1 | 6 ++++- .../Auth/Context/Resolve-GitHubContext.ps1 | 6 ++++- .../Context/Resolve-GitHubContextSetting.ps1 | 14 +++++++--- .../Auth/Context/Set-GitHubContext.ps1 | 4 ++- .../Invoke-GitHubDeviceFlowLogin.ps1 | 4 ++- .../DeviceFlow/Request-GitHubAccessToken.ps1 | 4 ++- .../DeviceFlow/Request-GitHubDeviceCode.ps1 | 4 ++- .../Test-GitHubAccessTokenRefreshRequired.ps1 | 4 ++- .../Update-GitHubUserAccessToken.ps1 | 6 ++++- .../DeviceFlow/Wait-GitHubAccessToken.ps1 | 6 ++++- .../private/Auth/Get-GitHubToken.ps1 | 10 ++++--- .../private/Auth/Test-GitHubToken.ps1 | 4 ++- .../private/Branches/Get-GitHubBranchList.ps1 | 4 ++- .../Commands/ConvertFrom-GitHubOutput.ps1 | 4 ++- .../Config/Initialize-GitHubConfig.ps1 | 6 ++++- .../Core/ConvertTo-GitHubGraphQLField.ps1 | 4 ++- .../Enterprise/Get-GitHubEnterpriseByName.ps1 | 6 +++-- .../Enterprise/Get-GitHubEnterpriseList.ps1 | 6 +++-- .../Get-GitHubEnvironmentByName.ps1 | 4 ++- .../Get-GitHubEnvironmentList.ps1 | 4 ++- .../Gitignore/Get-GitHubGitignoreByName.ps1 | 4 ++- .../Gitignore/Get-GitHubGitignoreList.ps1 | 4 ++- .../License/Get-GitHubLicenseByName.ps1 | 4 ++- .../private/License/Get-GitHubLicenseList.ps1 | 4 ++- .../License/Get-GitHubRepositoryLicense.ps1 | 4 ++- .../Block-GitHubUserByOrganization.ps1 | 4 ++- .../Get-GitHubBlockedUserByOrganization.ps1 | 4 ++- .../Test-GitHubBlockedUserByOrganization.ps1 | 4 ++- .../Unblock-GitHubUserByOrganization.ps1 | 4 ++- .../Get-GitHubAllOrganization.ps1 | 4 ++- .../Get-GitHubOrganizationByName.ps1 | 4 ++- .../Get-GitHubOrganizationListForAuthUser.ps1 | 6 +++-- .../Get-GitHubUserOrganization.ps1 | 4 ++- .../Assets/Get-GitHubReleaseAssetByID.ps1 | 4 ++- .../Get-GitHubReleaseAssetByReleaseID.ps1 | 6 ++++- .../Assets/Get-GitHubReleaseAssetByTag.ps1 | 6 ++++- .../Get-GitHubReleaseAssetFromLatest.ps1 | 6 ++++- .../private/Releases/Get-GitHubReleaseAll.ps1 | 4 ++- .../Releases/Get-GitHubReleaseByID.ps1 | 4 ++- .../Releases/Get-GitHubReleaseByTagName.ps1 | 4 ++- .../Releases/Get-GitHubReleaseLatest.ps1 | 4 ++- .../Get-GitHubRepositoryAutolinkById.ps1 | 4 ++- .../Get-GitHubRepositoryAutolinkList.ps1 | 4 ++- .../Repositories/Get-GitHubMyRepositories.ps1 | 6 ++++- .../Get-GitHubMyRepositoryByName.ps1 | 4 ++- .../Get-GitHubRepositoryByName.ps1 | 4 ++- .../Get-GitHubRepositoryByNameAndTeam.ps1 | 6 +++-- .../Get-GitHubRepositoryListByOwner.ps1 | 8 +++++- .../Get-GitHubRepositoryListByTeam.ps1 | 6 +++-- .../New-GitHubRepositoryAsFork.ps1 | 10 ++++++- .../New-GitHubRepositoryFromTemplate.ps1 | 4 ++- .../Repositories/New-GitHubRepositoryOrg.ps1 | 4 ++- .../Repositories/New-GitHubRepositoryUser.ps1 | 4 ++- .../Get-GitHubRepositoryRuleSuiteById.ps1 | 4 ++- .../Get-GitHubRepositoryRuleSuiteList.ps1 | 4 ++- .../Get-GitHubSecretEnvironmentByName.ps1 | 6 +++-- .../Get-GitHubSecretEnvironmentList.ps1 | 6 +++-- .../Get-GitHubSecretFromOrganization.ps1 | 6 +++-- .../Secrets/Get-GitHubSecretOwnerByName.ps1 | 6 +++-- .../Secrets/Get-GitHubSecretOwnerList.ps1 | 6 +++-- .../Get-GitHubSecretRepositoryByName.ps1 | 6 +++-- .../Get-GitHubSecretRepositoryList.ps1 | 6 +++-- ...-GitHubPublicKeyForActionOnEnvironment.ps1 | 6 +++-- ...GitHubPublicKeyForActionOnOrganization.ps1 | 6 +++-- ...t-GitHubPublicKeyForActionOnRepository.ps1 | 6 +++-- ...ubPublicKeyForCodespacesOnOrganization.ps1 | 6 +++-- ...tHubPublicKeyForCodespacesOnRepository.ps1 | 6 +++-- ...Get-GitHubPublicKeyForCodespacesOnUser.ps1 | 6 +++-- .../Remove-GitHubSecretFromEnvironment.ps1 | 4 ++- .../Secrets/Remove-GitHubSecretFromOwner.ps1 | 4 ++- .../Remove-GitHubSecretFromRepository.ps1 | 4 ++- .../Secrets/Set-GitHubSecretOnEnvironment.ps1 | 4 ++- .../Secrets/Set-GitHubSecretOnOwner.ps1 | 4 ++- .../Secrets/Set-GitHubSecretOnRepository.ps1 | 4 ++- .../private/Teams/Get-GitHubTeamBySlug.ps1 | 4 ++- .../private/Teams/Get-GitHubTeamListByOrg.ps1 | 4 ++- .../Teams/Get-GitHubTeamListByRepo.ps1 | 6 +++-- .../Users/Blocking/Block-GitHubUserByUser.ps1 | 4 ++- .../Blocking/Get-GitHubBlockedUserByUser.ps1 | 4 ++- .../Blocking/Test-GitHubBlockedUserByUser.ps1 | 4 ++- .../Blocking/Unblock-GitHubUserByUser.ps1 | 4 ++- .../Users/Emails/Get-GitHubUserAllEmail.ps1 | 4 ++- .../Emails/Get-GitHubUserPublicEmail.ps1 | 4 ++- .../Get-GitHubUserFollowersOfUser.ps1 | 4 ++- .../Followers/Get-GitHubUserFollowingMe.ps1 | 4 ++- .../Followers/Get-GitHubUserFollowingUser.ps1 | 4 ++- .../Followers/Get-GitHubUserMyFollower.ps1 | 4 ++- .../Followers/Test-GitHubUserFollowedByMe.ps1 | 4 ++- .../Test-GitHubUserFollowedByUser.ps1 | 4 ++- .../GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 | 4 ++- .../Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 | 4 ++- .../GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 | 4 ++- .../private/Users/Get-GitHubAllUser.ps1 | 4 ++- .../private/Users/Get-GitHubMyUser.ps1 | 4 ++- .../private/Users/Get-GitHubUserByName.ps1 | 4 ++- .../Users/Keys/Get-GitHubUserKeyForUser.ps1 | 4 ++- .../Users/Keys/Get-GitHubUserMyKey.ps1 | 4 ++- .../Users/Keys/Get-GitHubUserMyKeyById.ps1 | 4 ++- .../Get-GitHubUserMySigningKey.ps1 | 4 ++- .../Get-GitHubUserMySigningKeyById.ps1 | 4 ++- .../Get-GitHubUserSigningKeyForUser.ps1 | 4 ++- .../Get-GitHubMyUserSocials.ps1 | 4 ++- .../Get-GitHubUserSocialsByName.ps1 | 4 ++- .../PowerShell/Get-FunctionParameter.ps1 | 8 +++++- .../PowerShell/Get-PSCallStackPath.ps1 | 8 +++++- .../PowerShell/Test-GitHubAzPowerShell.ps1 | 2 ++ .../PowerShell/Test-GitHubAzureCLI.ps1 | 2 ++ .../Get-GitHubVariableEnvironmentByName.ps1 | 6 +++-- .../Get-GitHubVariableEnvironmentList.ps1 | 6 +++-- .../Get-GitHubVariableFromOrganization.ps1 | 6 +++-- .../Get-GitHubVariableOwnerByName.ps1 | 6 +++-- .../Variables/Get-GitHubVariableOwnerList.ps1 | 6 +++-- .../Get-GitHubVariableRepositoryByName.ps1 | 6 +++-- .../Get-GitHubVariableRepositoryList.ps1 | 6 +++-- .../New-GitHubVariableOnEnvironment.ps1 | 4 ++- .../Variables/New-GitHubVariableOnOwner.ps1 | 4 ++- .../New-GitHubVariableOnRepository.ps1 | 4 ++- .../Remove-GitHubVariableFromEnvironment.ps1 | 4 ++- .../Remove-GitHubVariableFromOwner.ps1 | 4 ++- .../Remove-GitHubVariableFromRepository.ps1 | 4 ++- .../Update-GitHubVariableOnEnvironment.ps1 | 4 ++- .../Update-GitHubVariableOnOwner.ps1 | 4 ++- .../Update-GitHubVariableOnRepository.ps1 | 4 ++- .../Get-GitHubAppWebhookDeliveryByID.ps1 | 4 ++- .../Get-GitHubAppWebhookDeliveryByList.ps1 | 4 ++- ...et-GitHubAppWebhookDeliveryToRedeliver.ps1 | 4 ++- src/functions/public/API/Invoke-GitHubAPI.ps1 | 8 +++++- .../public/API/Invoke-GitHubGraphQLQuery.ps1 | 4 ++- .../Actions/Data/Get-GitHubEventData.ps1 | 4 ++- .../Actions/Data/Get-GitHubRunnerData.ps1 | 4 ++- ...-GitHubAppInstallationRepositoryAccess.ps1 | 4 ++- .../Get-GitHubAppAccessibleRepository.ps1 | 4 ++- ...-GitHubAppInstallationRepositoryAccess.ps1 | 4 ++- .../New-GitHubAppInstallationAccessToken.ps1 | 6 ++++- ...-GitHubAppInstallationRepositoryAccess.ps1 | 4 ++- ...-GitHubAppInstallationRepositoryAccess.ps1 | 6 ++++- .../public/Apps/GitHub App/Get-GitHubApp.ps1 | 6 ++++- .../Get-GitHubAppInstallationRequest.ps1 | 4 ++- .../Apps/GitHub App/Install-GitHubApp.ps1 | 6 ++++- .../Apps/GitHub App/Uninstall-GitHubApp.ps1 | 10 ++++++- .../public/Artifacts/Get-GitHubArtifact.ps1 | 18 +++++++++---- .../Artifacts/Remove-GitHubArtifact.ps1 | 2 ++ .../public/Artifacts/Save-GitHubArtifact.ps1 | 10 ++++--- .../public/Auth/Connect-GitHubAccount.ps1 | 10 ++++++- .../public/Auth/Connect-GitHubApp.ps1 | 10 ++++++- .../public/Auth/Context/Get-GitHubContext.ps1 | 4 ++- .../Auth/Context/Switch-GitHubContext.ps1 | 4 ++- .../public/Auth/Disconnect-GitHubAccount.ps1 | 10 ++++++- .../public/Auth/Get-GitHubAccessToken.ps1 | 10 ++++--- .../public/Auth/Get-GitHubViewer.ps1 | 4 ++- .../public/Commands/Add-GitHubMask.ps1 | 6 ++++- .../public/Commands/Add-GitHubSystemPath.ps1 | 4 ++- .../public/Commands/Disable-GitHubCommand.ps1 | 4 ++- .../public/Commands/Enable-GitHubCommand.ps1 | 4 ++- .../public/Commands/Get-GitHubOutput.ps1 | 6 ++++- .../public/Commands/Reset-GitHubOutput.ps1 | 4 ++- .../Set-GitHubEnvironmentVariable.ps1 | 4 ++- .../public/Commands/Set-GitHubLogGroup.ps1 | 6 ++++- .../Commands/Set-GitHubNoCommandGroup.ps1 | 6 ++++- .../public/Commands/Set-GitHubOutput.ps1 | 6 ++++- .../public/Commands/Set-GitHubStepSummary.ps1 | 4 ++- .../public/Commands/Start-GitHubLogGroup.ps1 | 6 ++++- .../public/Commands/Stop-GitHubLogGroup.ps1 | 6 ++++- .../public/Commands/Write-GitHubDebug.ps1 | 4 ++- .../public/Commands/Write-GitHubError.ps1 | 4 ++- .../public/Commands/Write-GitHubLog.ps1 | 8 +++++- .../public/Commands/Write-GitHubNotice.ps1 | 4 ++- .../public/Commands/Write-GitHubWarning.ps1 | 4 ++- .../public/Config/Get-GitHubConfig.ps1 | 4 ++- .../public/Config/Remove-GitHubConfig.ps1 | 4 ++- .../public/Config/Reset-GitHubConfig.ps1 | 4 ++- .../public/Config/Set-GitHubConfig.ps1 | 4 ++- .../public/Emojis/Get-GitHubEmoji.ps1 | 6 ++++- .../Enterprise/Get-GitHubEnterprise.ps1 | 10 ++++--- .../Get-GitHubEnterpriseOrganization.ps1 | 4 ++- .../Environments/Get-GitHubEnvironment.ps1 | 6 ++++- .../Environments/Remove-GitHubEnvironment.ps1 | 2 ++ .../Environments/Set-GitHubEnvironment.ps1 | 6 +++-- .../public/Git/Get-GitHubGitConfig.ps1 | 4 ++- .../public/Git/Set-GitHubGitConfig.ps1 | 6 ++++- .../public/Gitignore/Get-GitHubGitignore.ps1 | 6 ++++- .../public/Issues/ConvertFrom-IssueForm.ps1 | 4 ++- .../public/License/Get-GitHubLicense.ps1 | 8 +++++- .../public/Markdown/Get-GitHubMarkdown.ps1 | 4 ++- .../public/Markdown/Get-GitHubMarkdownRaw.ps1 | 4 ++- .../public/Meta/Get-GitHubApiVersion.ps1 | 4 ++- src/functions/public/Meta/Get-GitHubMeta.ps1 | 4 ++- .../public/Meta/Get-GitHubOctocat.ps1 | 6 ++++- src/functions/public/Meta/Get-GitHubRoot.ps1 | 4 ++- src/functions/public/Meta/Get-GitHubZen.ps1 | 4 ++- .../Organization/Get-GitHubOrganization.ps1 | 12 ++++++++- ...et-GitHubOrganizationPendingInvitation.ps1 | 6 ++++- .../New-GitHubOrganizationInvitation.ps1 | 6 ++++- .../Remove-GitHubOrganizationInvitation.ps1 | 4 ++- .../Organization/New-GitHubOrganization.ps1 | 4 ++- .../Remove-GitHubOrganization.ps1 | 4 ++- .../Update-GitHubOrganization.ps1 | 6 ++++- .../public/Rate-Limit/Get-GitHubRateLimit.ps1 | 4 ++- .../Assets/Add-GitHubReleaseAsset.ps1 | 6 ++++- .../Assets/Get-GitHubReleaseAsset.ps1 | 10 ++++++- .../Assets/Remove-GitHubReleaseAsset.ps1 | 2 ++ .../Assets/Save-GitHubReleaseAsset.ps1 | 12 ++++++--- .../Assets/Update-GitHubReleaseAsset.ps1 | 4 ++- .../public/Releases/Get-GitHubRelease.ps1 | 10 ++++++- .../public/Releases/New-GitHubRelease.ps1 | 12 ++++++++- .../public/Releases/New-GitHubReleaseNote.ps1 | 8 +++++- .../public/Releases/Remove-GitHubRelease.ps1 | 2 ++ .../public/Releases/Set-GitHubRelease.ps1 | 16 +++++++++++- .../public/Releases/Update-GitHubRelease.ps1 | 10 ++++++- .../Get-GitHubRepositoryAutolink.ps1 | 6 ++++- .../New-GitHubRepositoryAutolink.ps1 | 4 ++- .../Remove-GitHubRepositoryAutolink.ps1 | 4 ++- .../Get-GitHubRepositoryCustomProperty.ps1 | 4 ++- .../Repositories/Get-GitHubRepository.ps1 | 12 ++++++++- .../Repositories/Move-GitHubRepository.ps1 | 4 ++- .../Repositories/New-GitHubRepository.ps1 | 10 ++++++- .../Get-GitHubRepositoryPermission.ps1 | 8 ++++-- .../Remove-GitHubRepositoryPermission.ps1 | 4 ++- .../Set-GitHubRepositoryPermission.ps1 | 4 ++- .../Repositories/Remove-GitHubRepository.ps1 | 4 ++- ...epositoryPrivateVulnerabilityReporting.ps1 | 4 ++- .../Disable-GitHubRepositorySecurityFix.ps1 | 4 ++- ...ble-GitHubRepositoryVulnerabilityAlert.ps1 | 4 ++- ...epositoryPrivateVulnerabilityReporting.ps1 | 4 ++- .../Enable-GitHubRepositorySecurityFix.ps1 | 4 ++- ...ble-GitHubRepositoryVulnerabilityAlert.ps1 | 4 ++- .../Get-GitHubRepositoryActivity.ps1 | 20 +++++++++++++- .../Get-GitHubRepositoryCodeownersError.ps1 | 4 ++- .../Get-GitHubRepositoryContributor.ps1 | 4 ++- .../Repositories/Get-GitHubRepositoryFork.ps1 | 4 ++- .../Get-GitHubRepositoryLanguage.ps1 | 4 ++- .../Get-GitHubRepositorySecurityFix.ps1 | 4 ++- .../Repositories/Get-GitHubRepositoryTag.ps1 | 4 ++- .../Repositories/Get-GitHubRepositoryTeam.ps1 | 4 ++- .../Get-GitHubRepositoryTopic.ps1 | 4 ++- .../Set-GitHubRepositoryTopic.ps1 | 4 ++- .../Start-GitHubRepositoryEvent.ps1 | 4 ++- ...est-GitHubRepositoryVulnerabilityAlert.ps1 | 4 ++- .../Get-GitHubRepositoryRuleSuite.ps1 | 6 ++++- .../Repositories/Set-GitHubRepository.ps1 | 6 ++++- .../Repositories/Update-GitHubRepository.ps1 | 6 ++++- .../public/Secrets/Get-GitHubPublicKey.ps1 | 8 +++++- .../public/Secrets/Get-GitHubSecret.ps1 | 8 +++++- .../public/Secrets/Remove-GitHubSecret.ps1 | 8 +++++- .../Add-GitHubSecretSelectedRepository.ps1 | 4 ++- .../Get-GitHubSecretSelectedRepository.ps1 | 6 +++-- .../Remove-GitHubSecretSelectedRepository.ps1 | 4 ++- .../Set-GitHubSecretSelectedRepository.ps1 | 4 ++- .../public/Secrets/Set-GitHubSecret.ps1 | 8 +++++- .../Status/Get-GitHubScheduledMaintenance.ps1 | 8 +++++- .../public/Status/Get-GitHubStatus.ps1 | 6 ++++- .../Status/Get-GitHubStatusComponent.ps1 | 4 ++- .../Status/Get-GitHubStatusIncident.ps1 | 6 ++++- src/functions/public/Teams/Get-GitHubTeam.ps1 | 8 +++++- src/functions/public/Teams/New-GitHubTeam.ps1 | 4 ++- .../public/Teams/Remove-GitHubTeam.ps1 | 4 ++- .../public/Teams/Update-GitHubTeam.ps1 | 4 ++- .../Users/Blocking/Block-GitHubUser.ps1 | 6 ++++- .../Users/Blocking/Get-GitHubBlockedUser.ps1 | 6 ++++- .../Users/Blocking/Test-GitHubBlockedUser.ps1 | 6 ++++- .../Users/Blocking/Unblock-GitHubUser.ps1 | 6 ++++- .../Users/Emails/Add-GitHubUserEmail.ps1 | 4 ++- .../Users/Emails/Get-GitHubUserEmail.ps1 | 6 ++++- .../Users/Emails/Remove-GitHubUserEmail.ps1 | 4 ++- .../Update-GitHubUserEmailVisibility.ps1 | 6 ++++- .../Followers/Add-GitHubUserFollowing.ps1 | 4 ++- .../Followers/Get-GitHubUserFollower.ps1 | 6 ++++- .../Followers/Get-GitHubUserFollowing.ps1 | 6 ++++- .../Followers/Remove-GitHubUserFollowing.ps1 | 4 ++- .../Followers/Test-GitHubUserFollowing.ps1 | 6 ++++- .../Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 | 4 ++- .../Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 | 8 +++++- .../GPG-Keys/Remove-GitHubUserGpgKey.ps1 | 2 ++ src/functions/public/Users/Get-GitHubUser.ps1 | 8 +++++- .../public/Users/Keys/Add-GitHubUserKey.ps1 | 4 ++- .../public/Users/Keys/Get-GitHubUserKey.ps1 | 8 +++++- .../Users/Keys/Remove-GitHubUserKey.ps1 | 2 ++ .../Add-GitHubUserSigningKey.ps1 | 4 ++- .../Get-GitHubUserSigningKey.ps1 | 8 +++++- .../Remove-GitHubUserSigningKey.ps1 | 2 ++ .../Social-Accounts/Add-GitHubUserSocial.ps1 | 4 ++- .../Remove-GitHubUserSocial.ps1 | 4 ++- .../public/Users/Update-GitHubUser.ps1 | 8 +++++- .../Variables/Export-GitHubVariable.ps1 | 4 ++- .../public/Variables/Get-GitHubVariable.ps1 | 26 ++++++++++++++----- .../public/Variables/New-GitHubVariable.ps1 | 8 +++++- .../Variables/Remove-GitHubVariable.ps1 | 8 +++++- .../Add-GitHubVariableSelectedRepository.ps1 | 4 ++- .../Get-GitHubVariableSelectedRepository.ps1 | 4 ++- ...emove-GitHubVariableSelectedRepository.ps1 | 4 ++- .../Set-GitHubVariableSelectedRepository.ps1 | 4 ++- .../public/Variables/Set-GitHubVariable.ps1 | 8 +++++- .../Variables/Update-GitHubVariable.ps1 | 8 +++++- .../Get-GitHubAppWebhookConfiguration.ps1 | 4 ++- .../Webhooks/Get-GitHubAppWebhookDelivery.ps1 | 6 ++++- .../Invoke-GitHubAppWebhookReDelivery.ps1 | 4 ++- .../Webhooks/Test-GitHubWebhookSignature.ps1 | 10 ++++--- .../Update-GitHubAppWebhookConfiguration.ps1 | 6 +++-- .../Workflows/Disable-GitHubWorkflow.ps1 | 4 ++- .../Workflows/Enable-GitHubWorkflow.ps1 | 6 ++++- .../public/Workflows/Get-GitHubWorkflow.ps1 | 6 ++++- .../Workflows/Runs/Get-GitHubWorkflowRun.ps1 | 10 ++++++- .../Runs/Remove-GitHubWorkflowRun.ps1 | 2 ++ .../Runs/Restart-GitHubWorkflowRun.ps1 | 4 ++- .../Workflows/Runs/Stop-GitHubWorkflowRun.ps1 | 4 ++- .../public/Workflows/Start-GitHubWorkflow.ps1 | 4 ++- tools/utilities/New-FunctionTemplate.ps1 | 4 ++- 331 files changed, 1379 insertions(+), 379 deletions(-) diff --git a/src/functions/private/Actions/Import-GitHubEventData.ps1 b/src/functions/private/Actions/Import-GitHubEventData.ps1 index fa5cf33de..50b01bf36 100644 --- a/src/functions/private/Actions/Import-GitHubEventData.ps1 +++ b/src/functions/private/Actions/Import-GitHubEventData.ps1 @@ -1,4 +1,4 @@ -#Requires -Modules @{ ModuleName = 'CasingStyle'; RequiredVersion = '1.0.2' } +#Requires -Modules @{ ModuleName = 'CasingStyle'; RequiredVersion = '1.0.2' } function Import-GitHubEventData { <# @@ -9,7 +9,9 @@ function Import-GitHubEventData { Import data from the event that triggered the workflow. .EXAMPLE + ```pwsh Import-GitHubEventData + ``` #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', diff --git a/src/functions/private/Actions/Import-GitHubRunnerData.ps1 b/src/functions/private/Actions/Import-GitHubRunnerData.ps1 index 3a8ae9542..33d964e95 100644 --- a/src/functions/private/Actions/Import-GitHubRunnerData.ps1 +++ b/src/functions/private/Actions/Import-GitHubRunnerData.ps1 @@ -1,4 +1,4 @@ -function Import-GitHubRunnerData { +function Import-GitHubRunnerData { <# .SYNOPSIS Import data about the runner that is running the workflow. @@ -7,7 +7,9 @@ Import data about the runner that is running the workflow. .EXAMPLE + ```pwsh Import-GitHubRunnerData + ``` #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', diff --git a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 index 9f756123c..b2c832831 100644 --- a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 +++ b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflowRunByRepo { +filter Get-GitHubWorkflowRunByRepo { <# .SYNOPSIS List workflow runs for a repository. @@ -12,12 +12,16 @@ `created`, `event`, `head_sha`, `status`. .EXAMPLE + ```pwsh Get-GitHubWorkflowRunByRepo -Owner 'owner' -Repository 'repo' + ``` Lists all workflow runs for a repository. .EXAMPLE + ```pwsh Get-GitHubWorkflowRunByRepo -Owner 'owner' -Repository 'repo' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' + ``` Lists all workflow runs for a repository with the specified actor, branch, event, and status. diff --git a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 index 918fd069d..c008037a4 100644 --- a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 +++ b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflowRunByWorkflow { +filter Get-GitHubWorkflowRunByWorkflow { <# .SYNOPSIS List workflow runs for a workflow @@ -13,12 +13,16 @@ `created`, `event`, `head_sha`, `status`. .EXAMPLE + ```pwsh Get-GitHubWorkflowRunByWorkflow -Owner 'octocat' -Repository 'Hello-World' -ID '42' + ``` Gets all workflow runs for the workflow with the ID `42` in the repository `Hello-World` owned by `octocat`. .EXAMPLE + ```pwsh Get-GitHubWorkflowRunByWorkflow -Owner 'octocat' -Repository 'Hello-World' -ID '42' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' + ``` Gets all workflow runs for the workflow with the ID `42` in the repository `Hello-World` owned by `octocat` that were triggered by the user `octocat` on the branch `main` and have the status `success`. diff --git a/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 b/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 index 1665a309c..ce4349d4a 100644 --- a/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubKeyVaultJWTSignature { +function Add-GitHubKeyVaultJWTSignature { <# .SYNOPSIS Adds a JWT signature using Azure Key Vault. @@ -8,10 +8,12 @@ The function supports authentication via Azure CLI or Az PowerShell module and returns the signed JWT as a secure string. .EXAMPLE + ```pwsh Add-GitHubKeyVaultJWTSignature -UnsignedJWT 'header.payload' -KeyVaultKeyReference 'https://myvault.vault.azure.net/keys/mykey' + ``` Output: - ```powershell + ```pwsh System.Security.SecureString ``` diff --git a/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 b/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 index 1c14e89f3..906fd35b5 100644 --- a/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubLocalJWTSignature { +function Add-GitHubLocalJWTSignature { <# .SYNOPSIS Signs a JSON Web Token (JWT) using a local RSA private key. @@ -8,7 +8,9 @@ This function handles the RSA signing process and returns the complete signed JWT. .EXAMPLE + ```pwsh Add-GitHubLocalJWTSignature -UnsignedJWT 'eyJ0eXAiOi...' -PrivateKey '--- BEGIN RSA PRIVATE KEY --- ... --- END RSA PRIVATE KEY ---' + ``` Adds a signature to the unsigned JWT using the provided private key. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 index b5383bc2c..c4b51ed75 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAppAsAuthenticatedApp { +filter Get-GitHubAppAsAuthenticatedApp { <# .SYNOPSIS Get the authenticated app @@ -13,7 +13,9 @@ to access this endpoint. .EXAMPLE + ```pwsh Get-GitHubAppAsAuthenticatedApp + ``` Get the authenticated app. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 index ce921c706..acbc0394a 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppBySlug { +function Get-GitHubAppBySlug { <# .SYNOPSIS Get an app @@ -7,7 +7,9 @@ Gets a single GitHub App using the app's slug. .EXAMPLE + ```pwsh Get-GitHubAppByName -AppSlug 'github-actions' + ``` Gets the GitHub App with the slug 'github-actions'. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 index 06e229ebd..7484df062 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallableOrganization { +function Get-GitHubAppInstallableOrganization { <# .SYNOPSIS Get enterprise-owned organizations that can have GitHub Apps installed @@ -11,7 +11,9 @@ - enterprise_organization_installations: read .EXAMPLE + ```pwsh Get-GitHubAppInstallableOrganization -Enterprise 'msx' + ``` .OUTPUTS GitHubOrganization[] diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 index 49bf28609..a2f616bb8 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForAuthenticatedAppAsList { +function Get-GitHubAppInstallationForAuthenticatedAppAsList { <# .SYNOPSIS List installations for the authenticated app. @@ -10,7 +10,9 @@ to access this endpoint. .EXAMPLE + ```pwsh Get-GitHubAppInstallationForAuthenticatedAppAsList + ``` List installations for the authenticated app. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 index 0c16a017b..9d6bd22a3 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForAuthenticatedAppByID { +function Get-GitHubAppInstallationForAuthenticatedAppByID { <# .SYNOPSIS Get an installation for the authenticated app. @@ -10,7 +10,9 @@ to access this endpoint. .EXAMPLE + ```pwsh Get-GitHubAppInstallationForAuthenticatedAppByID -ID 123456 + ``` Get an installation for the authenticated app with the specified ID. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 index 208c6d4c7..77ae6c0a1 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForEnterpriseOrganization { +function Get-GitHubAppInstallationForEnterpriseOrganization { <# .SYNOPSIS List GitHub Apps installed on an enterprise-owned organization @@ -9,7 +9,9 @@ The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (read) permission. .EXAMPLE + ```pwsh Get-GitHubAppInstallationForEnterpriseOrganization -Enterprise 'msx' -Organization 'github' + ``` Gets all GitHub Apps in the organization `github` in the enterprise `msx`. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 index f53d15106..160df468c 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForOrganization { +function Get-GitHubAppInstallationForOrganization { <# .SYNOPSIS List app installations for an organization @@ -8,7 +8,9 @@ You must be an organization owner with `admin:read` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubAppInstallationForOrganization -Organization 'github' + ``` Gets all GitHub Apps in the organization `github`. diff --git a/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 index d417c0628..9e56bbde7 100644 --- a/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Install-GitHubAppOnEnterpriseOrganization { +function Install-GitHubAppOnEnterpriseOrganization { <# .SYNOPSIS Install an app on an Enterprise-owned organization @@ -9,7 +9,9 @@ The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (write) permission. .EXAMPLE + ```pwsh Install-GitHubAppOnEnterpriseOrganization -Enterprise 'msx' -Organization 'org' -ClientID '123456' + ``` #> [OutputType([GitHubAppInstallation])] [CmdletBinding()] diff --git a/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 b/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 index 16d3264cc..d266ff06b 100644 --- a/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 +++ b/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 @@ -1,4 +1,4 @@ -function New-GitHubUnsignedJWT { +function New-GitHubUnsignedJWT { <# .SYNOPSIS Creates an unsigned JSON Web Token (JWT) for a GitHub App. @@ -9,7 +9,9 @@ that can be passed to a signing function. .EXAMPLE + ```pwsh New-GitHubUnsignedJWT -ClientId 'Iv987654321' + ``` Creates an unsigned JWT for a GitHub App using the specified client ID. diff --git a/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 b/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 index 4db614e1f..3245c2eb4 100644 --- a/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 @@ -7,7 +7,9 @@ function Test-GitHubJWTRefreshRequired { Test if the GitHub JWT should be refreshed. JWTs are refreshed when they have 150 seconds or less remaining before expiration. .EXAMPLE + ```pwsh Test-GitHubJWTRefreshRequired -Context $Context + ``` This will test if the GitHub JWT should be refreshed for the specified context. diff --git a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 index 2b6defff8..f90e508fc 100644 --- a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 @@ -7,7 +7,9 @@ function Uninstall-GitHubAppAsApp { Deletes a GitHub App installation using the authenticated App context. .EXAMPLE + ```pwsh Uninstall-GitHubAppAsApp -ID 123456 -Context $appContext + ``` Deletes the installation with ID 123456 for the authenticated app. diff --git a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 index 60dab447f..f5e5dd195 100644 --- a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Uninstall-GitHubAppOnEnterpriseOrganization { +function Uninstall-GitHubAppOnEnterpriseOrganization { <# .SYNOPSIS Uninstall a GitHub App from an enterprise-owned organization. @@ -9,7 +9,9 @@ The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (write) permission. .EXAMPLE + ```pwsh Uninstall-GitHubAppOnEnterpriseOrganization -Enterprise 'github' -Organization 'octokit' -ID '123456' + ``` Uninstall the GitHub App with the installation ID `123456` from the organization `octokit` in the enterprise `github`. diff --git a/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 b/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 index e9f6892e4..65d181e4b 100644 --- a/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubAppJWT { +function Update-GitHubAppJWT { <# .SYNOPSIS Updates a JSON Web Token (JWT) for a GitHub App context. @@ -8,17 +8,23 @@ it will be refreshed. This function implements mutex-based locking to prevent concurrent refreshes. .EXAMPLE + ```pwsh Update-GitHubAppJWT -Context $Context + ``` Updates the JSON Web Token (JWT) for a GitHub App using the specified context. .EXAMPLE + ```pwsh Update-GitHubAppJWT -Context $Context -PassThru + ``` This will update the GitHub App JWT for the specified context and return the updated context. .EXAMPLE + ```pwsh Update-GitHubAppJWT -Context $Context -Silent + ``` This will update the GitHub App JWT for the specified context without displaying progress messages. diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 index 0c0c911b0..eed955e78 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifactById { +function Get-GitHubArtifactById { <# .SYNOPSIS Retrieves a specific artifact from a GitHub Actions workflow run. @@ -9,10 +9,12 @@ The function returns a custom GitHubArtifact object containing metadata and download information for the artifact. .EXAMPLE + ```pwsh Get-GitHubArtifactById -Owner 'octocat' -Repository 'hello-world' -ID '123456' + ``` Output: - ```powershell + ```pwsh Name : build-artifact ID : 123456 Url : https://api.github.com/repos/octocat/hello-world/actions/artifacts/123456 diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 index 8b12374ce..9efeaeb56 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifactFromRepository { +function Get-GitHubArtifactFromRepository { <# .SYNOPSIS Lists artifacts for a GitHub repository. @@ -10,10 +10,12 @@ By default, only the latest version of each artifact is returned unless -AllVersions is specified. .EXAMPLE + ```pwsh Get-GitHubArtifactFromRepository -Owner 'octocat' -Repository 'demo-repo' -AllVersions + ``` Output: - ```powershell + ```pwsh Name : build-output ID : 4567890 Expired : False diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 index 07b2c9522..79ec4161e 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifactFromWorkflowRun { +function Get-GitHubArtifactFromWorkflowRun { <# .SYNOPSIS Retrieves artifacts from a specific GitHub Actions workflow run. @@ -9,10 +9,12 @@ The function can optionally filter artifacts by name or return only the latest version per artifact name. .EXAMPLE + ```pwsh Get-GitHubArtifactFromWorkflowRun -Owner 'octocat' -Repository 'demo' -ID '123456789' + ``` Output: - ```powershell + ```pwsh ID : 10 NodeID : MDEwOkFydGlmYWN0MQ== Name : build-logs diff --git a/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 b/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 index dd77bdf7d..4824841ef 100644 --- a/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 +++ b/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 @@ -1,4 +1,4 @@ -filter Connect-GitHubCli { +filter Connect-GitHubCli { <# .SYNOPSIS Authenticates to GitHub CLI using a secure token from the provided context. @@ -9,11 +9,13 @@ If authentication fails, a warning is displayed, and `LASTEXITCODE` is reset to `0`. .EXAMPLE + ```pwsh $context = Connect-GitHubAccount $context | Connect-GitHubCli + ``` Output: - ```powershell + ```pwsh (No output unless an error occurs) ``` diff --git a/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 b/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 index 60538b622..b6ecd0d75 100644 --- a/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 @@ -1,4 +1,4 @@ -filter Assert-GitHubContext { +filter Assert-GitHubContext { <# .SYNOPSIS Check if the context meets the requirements for the command. @@ -8,7 +8,9 @@ If the context does not meet the requirements, an error is thrown. .EXAMPLE + ```pwsh Assert-GitHubContext -Context 'github.com/Octocat' -AuthType 'App' + ``` #> [OutputType([void])] [CmdletBinding()] diff --git a/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 b/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 index 6d2b97dbd..9364c5710 100644 --- a/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubContext { +filter Remove-GitHubContext { <# .SYNOPSIS Removes a context from the context vault. @@ -9,12 +9,16 @@ If the specified context(s) exist, they will be removed from the vault. .EXAMPLE + ```pwsh Remove-Context + ``` Removes all contexts from the vault. .EXAMPLE + ```pwsh Remove-Context -ID 'MyContext' + ``` Removes the context called 'MyContext' from the vault. #> diff --git a/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 b/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 index a28e871a6..67bdb4380 100644 --- a/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 @@ -1,4 +1,4 @@ -filter Resolve-GitHubContext { +filter Resolve-GitHubContext { <# .SYNOPSIS Resolves the context into a GitHubContext object. @@ -11,12 +11,16 @@ If the context is a App, it will look at the available contexts and return the one that matches the scope of the command being run. .EXAMPLE + ```pwsh $Context = Resolve-GitHubContext -Context 'github.com/Octocat' + ``` This will resolve the context 'github.com/Octocat' into a GitHubContext object. .EXAMPLE + ```pwsh $Context = Resolve-GitHubContext -Context $GitHubContext + ``` This will return the GitHubContext object. #> diff --git a/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 b/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 index b152c6e96..94332fb6a 100644 --- a/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 +++ b/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 @@ -1,4 +1,4 @@ -function Resolve-GitHubContextSetting { +function Resolve-GitHubContextSetting { <# .SYNOPSIS Resolves a GitHub context setting based on a provided name. @@ -9,30 +9,36 @@ it will return the default value from the GitHub configuration. This is useful for resolving API-related settings dynamically. .EXAMPLE + ```pwsh Resolve-GitHubContextSetting -Name 'Repository' -Value 'MyRepo' + ``` Output: - ```powershell + ```pwsh MyRepo ``` Returns the provided value 'MyRepo' for the 'Repository' setting. .EXAMPLE + ```pwsh Resolve-GitHubContextSetting -Name 'Repository' -Context $GitHubContext + ``` Output: - ```powershell + ```pwsh MyRepository ``` Retrieves the 'Repository' setting from the provided GitHub context object. .EXAMPLE + ```pwsh Resolve-GitHubContextSetting -Name 'ApiBaseUrl' + ``` Output: - ```powershell + ```pwsh https://api.github.com ``` diff --git a/src/functions/private/Auth/Context/Set-GitHubContext.ps1 b/src/functions/private/Auth/Context/Set-GitHubContext.ps1 index ee39cdadf..a98d75461 100644 --- a/src/functions/private/Auth/Context/Set-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Set-GitHubContext.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubContext { +function Set-GitHubContext { <# .SYNOPSIS Sets the GitHub context and stores it in the context vault. @@ -8,6 +8,7 @@ The context is used to authenticate with the GitHub API. .EXAMPLE + ```pwsh $context = @{ ApiBaseUri = 'https://api.github.com' ApiVersion = '2022-11-28' @@ -18,6 +19,7 @@ Repository = 'Hello-World' } Set-GitHubContext -Context $context + ``` Sets the GitHub context with the specified settings as a hashtable. #> diff --git a/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 b/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 index 32afe8622..a181dbf02 100644 --- a/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 @@ -1,4 +1,4 @@ -function Invoke-GitHubDeviceFlowLogin { +function Invoke-GitHubDeviceFlowLogin { <# .SYNOPSIS Starts the GitHub Device Flow login process. @@ -7,7 +7,9 @@ Starts the GitHub Device Flow login process. This will prompt the user to visit a URL and enter a code. .EXAMPLE + ```pwsh Invoke-GitHubDeviceFlowLogin + ``` This will start the GitHub Device Flow login process. The user gets prompted to visit a URL and enter a code. diff --git a/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 index ed32bc697..2e35b62b2 100644 --- a/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 @@ -1,4 +1,4 @@ -function Request-GitHubAccessToken { +function Request-GitHubAccessToken { <# .SYNOPSIS Request a GitHub token using the Device Flow. @@ -8,7 +8,9 @@ This will poll the GitHub API until the user has entered the code. .EXAMPLE + ```pwsh Request-GitHubAccessToken -DeviceCode $deviceCode -ClientID $ClientID -HostName 'github.com' + ``` This will poll the GitHub API until the user has entered the code. diff --git a/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 b/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 index 9341aedec..59b170e59 100644 --- a/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 @@ -1,4 +1,4 @@ -function Request-GitHubDeviceCode { +function Request-GitHubDeviceCode { <# .SYNOPSIS Request a GitHub Device Code. @@ -7,7 +7,9 @@ Request a GitHub Device Code. .EXAMPLE + ```pwsh Request-GitHubDeviceCode -ClientID $ClientID -Mode $Mode -HostName 'github.com' + ``` This will request a GitHub Device Code. diff --git a/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 b/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 index 292ded46a..b7c6f9f92 100644 --- a/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubAccessTokenRefreshRequired { +function Test-GitHubAccessTokenRefreshRequired { <# .SYNOPSIS Test if the GitHub access token should be refreshed. @@ -7,7 +7,9 @@ Test if the GitHub access token should be refreshed. .EXAMPLE + ```pwsh Test-GitHubAccessTokenRefreshRequired + ``` This will test if the GitHub access token should be refreshed. #> diff --git a/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 index ab5183e7e..961c27e18 100644 --- a/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubUserAccessToken { +function Update-GitHubUserAccessToken { <# .SYNOPSIS Updates the GitHub access token. @@ -7,12 +7,16 @@ Updates the GitHub access token. If the access token is still valid, it will not be refreshed. .EXAMPLE + ```pwsh Update-GitHubUserAccessToken + ``` This will update the GitHub access token for the default context. .EXAMPLE + ```pwsh Update-GitHubUserAccessToken -Context 'github.com/mojombo' + ``` This will update the GitHub access token for the context 'github.com/mojombo'. diff --git a/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 index 6d1c65924..9bca3d29f 100644 --- a/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 @@ -1,4 +1,4 @@ -function Wait-GitHubAccessToken { +function Wait-GitHubAccessToken { <# .SYNOPSIS Waits for the GitHub Device Flow to complete. @@ -8,12 +8,16 @@ This will poll the GitHub API until the user has entered the code. .EXAMPLE + ```pwsh Wait-GitHubAccessToken -DeviceCode $deviceCode -ClientID $ClientID -Interval $interval + ``` This will poll the GitHub API until the user has entered the code. .EXAMPLE + ```pwsh Wait-GitHubAccessToken -Refresh -ClientID $ClientID + ``` .NOTES For more info about the Device Flow visit: diff --git a/src/functions/private/Auth/Get-GitHubToken.ps1 b/src/functions/private/Auth/Get-GitHubToken.ps1 index 491350e39..5cb94e170 100644 --- a/src/functions/private/Auth/Get-GitHubToken.ps1 +++ b/src/functions/private/Auth/Get-GitHubToken.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubToken { +function Get-GitHubToken { <# .SYNOPSIS Retrieves a GitHub token from environment variables as plaintext or a secure string. @@ -10,20 +10,24 @@ either a raw token value or a secure version for sensitive operations. .EXAMPLE + ```pwsh Get-GitHubToken + ``` Output: - ```powershell + ```pwsh System.Security.SecureString ``` Returns the GitHub token as a secure string for safer handling in scripts or automation. .EXAMPLE + ```pwsh Get-GitHubToken -AsPlainText + ``` Output: - ```powershell + ```pwsh ghp_XXXXXXXXXXXXXXXXXXXXXX ``` diff --git a/src/functions/private/Auth/Test-GitHubToken.ps1 b/src/functions/private/Auth/Test-GitHubToken.ps1 index 28a9c29d8..733b6b4fb 100644 --- a/src/functions/private/Auth/Test-GitHubToken.ps1 +++ b/src/functions/private/Auth/Test-GitHubToken.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubToken { +function Test-GitHubToken { <# .SYNOPSIS Tests if the GitHub token is set in the environment variables. @@ -7,7 +7,9 @@ This function checks if the GitHub token is available in the environment variables. .EXAMPLE + ```pwsh Test-GitHubToken + ``` #> [OutputType([bool])] [CmdletBinding()] diff --git a/src/functions/private/Branches/Get-GitHubBranchList.ps1 b/src/functions/private/Branches/Get-GitHubBranchList.ps1 index f68175b86..4dba98c02 100644 --- a/src/functions/private/Branches/Get-GitHubBranchList.ps1 +++ b/src/functions/private/Branches/Get-GitHubBranchList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBranchList { +filter Get-GitHubBranchList { <# .SYNOPSIS List branches @@ -7,7 +7,9 @@ Lists all branches from a repository .EXAMPLE + ```pwsh Get-GitHubBranchList -Owner 'octocat' -Repository 'Hello-World' + ``` Gets all the branches from the 'Hello-World' repository owned by 'octocat' diff --git a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 index bea418f38..21eaa84c2 100644 --- a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 +++ b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -filter ConvertFrom-GitHubOutput { +filter ConvertFrom-GitHubOutput { <# .SYNOPSIS Gets the GitHub output. @@ -8,6 +8,7 @@ supporting both single-line and multi-line values, and parsing JSON values. .EXAMPLE + ```pwsh $content = @' zen=something else result={"MyOutput":"Hello, World!","Status":"Success"} @@ -19,6 +20,7 @@ Config={"Nested":{"SubSetting":"SubValue"},"Setting1":"Value1","Setting2":2} Numbers=12345 '@ + ``` ConvertFrom-GitHubOutput -OutputContent $content diff --git a/src/functions/private/Config/Initialize-GitHubConfig.ps1 b/src/functions/private/Config/Initialize-GitHubConfig.ps1 index c8d733fa4..289b6c721 100644 --- a/src/functions/private/Config/Initialize-GitHubConfig.ps1 +++ b/src/functions/private/Config/Initialize-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Initialize-GitHubConfig { +function Initialize-GitHubConfig { <# .SYNOPSIS Initialize the GitHub module configuration. @@ -7,12 +7,16 @@ Initialize the GitHub module configuration. .EXAMPLE + ```pwsh Initialize-GitHubConfig + ``` Initializes the GitHub module configuration. .EXAMPLE + ```pwsh Initialize-GitHubConfig -Force + ``` Forces the initialization of the GitHub module configuration. #> diff --git a/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 b/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 index b2616810d..3bc26df57 100644 --- a/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 +++ b/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 @@ -1,4 +1,4 @@ -function ConvertTo-GitHubGraphQLField { +function ConvertTo-GitHubGraphQLField { <# .SYNOPSIS Converts property names to their corresponding GitHub GraphQL field syntax. @@ -10,8 +10,10 @@ Properties not found in the mapping table are skipped with a warning. .EXAMPLE + ```pwsh $fields = ConvertTo-GitHubGraphQLField -Property @('Name','Owner') -AdditionalProperty 'Url' -PropertyToGraphQLMap $map Returns the GraphQL fields for Name, Owner, and Url. + ``` .OUTPUTS string diff --git a/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 b/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 index 81d33aa5d..569c9a53c 100644 --- a/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 +++ b/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterpriseByName { +function Get-GitHubEnterpriseByName { <# .SYNOPSIS Retrieves details about a GitHub Enterprise instance by name (slug). @@ -9,10 +9,12 @@ information. .EXAMPLE + ```pwsh Get-GitHubEnterpriseByName -Name 'my-enterprise' + ``` Output: - ```powershell + ```pwsh Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise diff --git a/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 b/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 index cd2f890e4..b28d016e6 100644 --- a/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 +++ b/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterpriseList { +function Get-GitHubEnterpriseList { <# .SYNOPSIS Retrieves a list of all GitHub Enterprise instances. @@ -8,10 +8,12 @@ creation dates, and other metadata. It returns an array of objects of type GitHubEnterprise populated with this information. .EXAMPLE + ```pwsh Get-GitHubEnterpriseList + ``` Output: - ```powershell + ```pwsh Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise diff --git a/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 b/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 index bd0c7392d..73f94ce8a 100644 --- a/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 +++ b/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEnvironmentByName { +filter Get-GitHubEnvironmentByName { <# .SYNOPSIS Retrieves details of a specified GitHub environment. @@ -13,7 +13,9 @@ to use this function with a private repository. .EXAMPLE + ```pwsh Get-GitHubEnvironment -Owner 'PSModule' -Repository 'EnvironmentTest' -Name 'test' + ``` Output: ```pwsh diff --git a/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 b/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 index 3748f44a8..3cb7a2764 100644 --- a/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 +++ b/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEnvironmentList { +filter Get-GitHubEnvironmentList { <# .SYNOPSIS Lists the environments for a repository. @@ -10,7 +10,9 @@ to use this endpoint with a private repository. .EXAMPLE + ```pwsh Get-GitHubEnvironmentList -Owner 'PSModule' -Repository 'EnvironmentTest' + ``` Output: ```pwsh diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 index 704073b90..3c2f06992 100644 --- a/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 +++ b/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubGitignoreByName { +filter Get-GitHubGitignoreByName { <# .SYNOPSIS Get a gitignore template @@ -8,7 +8,9 @@ Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. .EXAMPLE + ```pwsh Get-GitHubGitignoreList + ``` Get all gitignore templates diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 index fc6f70114..3c3902d55 100644 --- a/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 +++ b/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubGitignoreList { +filter Get-GitHubGitignoreList { <# .SYNOPSIS Get all gitignore templates @@ -8,7 +8,9 @@ [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). .EXAMPLE + ```pwsh Get-GitHubGitignoreList + ``` Get all gitignore templates diff --git a/src/functions/private/License/Get-GitHubLicenseByName.ps1 b/src/functions/private/License/Get-GitHubLicenseByName.ps1 index e1924aaff..25bdb5443 100644 --- a/src/functions/private/License/Get-GitHubLicenseByName.ps1 +++ b/src/functions/private/License/Get-GitHubLicenseByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubLicenseByName { +filter Get-GitHubLicenseByName { <# .SYNOPSIS Get a license @@ -8,7 +8,9 @@ For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." .EXAMPLE + ```pwsh Get-GitHubGitignoreList + ``` Get all gitignore templates diff --git a/src/functions/private/License/Get-GitHubLicenseList.ps1 b/src/functions/private/License/Get-GitHubLicenseList.ps1 index 436596194..6702af06f 100644 --- a/src/functions/private/License/Get-GitHubLicenseList.ps1 +++ b/src/functions/private/License/Get-GitHubLicenseList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubLicenseList { +filter Get-GitHubLicenseList { <# .SYNOPSIS Get all commonly used licenses @@ -8,7 +8,9 @@ For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." .EXAMPLE + ```pwsh Get-GitHubLicenseList + ``` Get all commonly used licenses. diff --git a/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 b/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 index 31e4dfd1e..d69a7c588 100644 --- a/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 +++ b/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryLicense { +filter Get-GitHubRepositoryLicense { <# .SYNOPSIS Get the license for a repository @@ -10,7 +10,9 @@ [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. .EXAMPLE + ```pwsh Get-GitHubRepositoryLicense -Owner 'octocat' -Repository 'Hello-World' + ``` Get the license for the Hello-World repository from the octocat account. diff --git a/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 index d25d9f1e2..cc5869616 100644 --- a/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Block-GitHubUserByOrganization { +filter Block-GitHubUserByOrganization { <# .SYNOPSIS Block a user from an organization @@ -8,7 +8,9 @@ If the organization cannot block the given user a 422 is returned. .EXAMPLE + ```pwsh Block-GitHubUserByOrganization -Organization 'github' -Username 'octocat' + ``` Blocks the user 'octocat' from the organization 'github'. Returns $true if successful, $false if not. diff --git a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 index 5830f3a51..5fcb763f3 100644 --- a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBlockedUserByOrganization { +filter Get-GitHubBlockedUserByOrganization { <# .SYNOPSIS List users blocked by an organization @@ -7,7 +7,9 @@ List the users blocked by an organization. .EXAMPLE + ```pwsh Get-GitHubBlockedUserByOrganization -Organization 'github' + ``` Lists all users blocked by the organization `github`. diff --git a/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 index b2dbc1fac..5d0d83f2c 100644 --- a/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubBlockedUserByOrganization { +filter Test-GitHubBlockedUserByOrganization { <# .SYNOPSIS Check if a user is blocked by an organization @@ -8,7 +8,9 @@ Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. .EXAMPLE + ```pwsh Test-GitHubBlockedUserByOrganization -Organization 'PSModule' -Username 'octocat' + ``` Checks if the user `octocat` is blocked by the organization `PSModule`. Returns true if the user is blocked, false if not. diff --git a/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 index 384cf5a73..6f036e3b4 100644 --- a/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Unblock-GitHubUserByOrganization { +filter Unblock-GitHubUserByOrganization { <# .SYNOPSIS Unblock a user from an organization @@ -7,7 +7,9 @@ Unblocks the given user on behalf of the specified organization. .EXAMPLE + ```pwsh Unblock-GitHubUserByOrganization -Organization 'github' -Username 'octocat' + ``` Unblocks the user 'octocat' from the organization 'github'. Returns $true if successful. diff --git a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 index 159d39b7f..1ed6b85aa 100644 --- a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 +++ b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAllOrganization { +filter Get-GitHubAllOrganization { <# .SYNOPSIS List organizations @@ -10,7 +10,9 @@ Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. .EXAMPLE + ```pwsh Get-GitHubAllOrganization -Since 142951047 + ``` List organizations, starting with PSModule diff --git a/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 b/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 index 87b512ae2..c32be3103 100644 --- a/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 +++ b/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubOrganizationByName { +filter Get-GitHubOrganizationByName { <# .SYNOPSIS Get an organization @@ -15,7 +15,9 @@ for details. For an example response, see 'Response with GitHub plan information' below." .EXAMPLE + ```pwsh Get-GitHubOrganizationByName -Name 'github' + ``` Get the 'GitHub' organization diff --git a/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 b/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 index a8024ee6b..fa10956fa 100644 --- a/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 +++ b/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubOrganizationListForAuthUser { +function Get-GitHubOrganizationListForAuthUser { <# .SYNOPSIS Retrieves a list of all GitHub organizations for the authenticated user. @@ -8,10 +8,12 @@ creation dates, member counts, and other metadata. It returns an array of objects of type GitHubOrganization populated with this information. .EXAMPLE + ```pwsh Get-GitHubOrganizationListForAuthUser + ``` Output: - ```powershell + ```pwsh Name : MyOrganization Login : my-org URL : https://github.com/my-org diff --git a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 index f76da4920..5492d2bb2 100644 --- a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 +++ b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserOrganization { +filter Get-GitHubUserOrganization { <# .SYNOPSIS List organizations for a user @@ -13,7 +13,9 @@ API instead. .EXAMPLE + ```pwsh Get-GitHubUserOrganization -Username 'octocat' + ``` List public organizations for the user 'octocat'. diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 index 71a9a4053..273cdd672 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetByID { +filter Get-GitHubReleaseAssetByID { <# .SYNOPSIS Get a release asset by ID @@ -10,7 +10,9 @@ possible. API clients should handle both a `200` or `302` response. .EXAMPLE + ```pwsh Get-GitHubReleaseAssetByID -Owner 'octocat' -Repository 'hello-world' -ID '1234567' + ``` Gets the release asset with the ID '1234567' for the repository 'octocat/hello-world'. diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 index 6d81aeace..ff54e1b52 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetByReleaseID { +filter Get-GitHubReleaseAssetByReleaseID { <# .SYNOPSIS List release assets @@ -7,12 +7,16 @@ List release assets .EXAMPLE + ```pwsh Get-GitHubReleaseAssetByReleaseID -Owner 'octocat' -Repository 'hello-world' -ID '1234567' + ``` Gets the release assets for the release with the ID '1234567' for the repository 'octocat/hello-world'. .EXAMPLE + ```pwsh Get-GitHubReleaseAssetByReleaseID -Owner 'octocat' -Repository 'hello-world' -ID '1234567' -Name 'example.zip' + ``` Gets only the release asset named 'example.zip' for the release with the ID '1234567'. diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 index ad523dcc0..454ddd95d 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetByTag { +filter Get-GitHubReleaseAssetByTag { <# .SYNOPSIS Get release assets by tag name @@ -8,12 +8,16 @@ Uses pagination to retrieve all assets even if there are more than the maximum per page. .EXAMPLE + ```pwsh Get-GitHubReleaseAssetByTag -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' + ``` Gets all release assets for the release with the tag 'v1.0.0' for the repository 'octocat/hello-world'. .EXAMPLE + ```pwsh Get-GitHubReleaseAssetByTag -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Name 'app.zip' + ``` Gets a specific release asset named 'app.zip' from the release with the tag 'v1.0.0' for the repository 'octocat/hello-world'. diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 index c0bbde666..dfe73f22c 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetFromLatest { +filter Get-GitHubReleaseAssetFromLatest { <# .SYNOPSIS Get the assets of the latest release @@ -9,12 +9,16 @@ The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. .EXAMPLE + ```pwsh Get-GitHubReleaseAssetFromLatest -Owner 'octocat' -Repository 'hello-world' + ``` Gets the assets for the latest release of the repository 'hello-world' owned by 'octocat'. .EXAMPLE + ```pwsh Get-GitHubReleaseAssetFromLatest -Owner 'octocat' -Repository 'hello-world' -Name 'asset-name' + ``` Gets the assets for the latest release of the repository 'hello-world' owned by 'octocat'. diff --git a/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 b/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 index 4e04235f7..56b583bb7 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAll { +filter Get-GitHubReleaseAll { <# .SYNOPSIS List releases @@ -9,7 +9,9 @@ Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. .EXAMPLE + ```pwsh Get-GitHubReleaseAll -Owner 'octocat' -Repository 'hello-world' + ``` Gets all the releases for the repository 'hello-world' owned by 'octocat'. diff --git a/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 b/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 index 0fa9cf1f7..c3ce3eae7 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseByID { +filter Get-GitHubReleaseByID { <# .SYNOPSIS Get a release @@ -8,7 +8,9 @@ This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). .EXAMPLE + ```pwsh Get-GitHubReleaseById -Owner 'octocat' -Repository 'hello-world' -ID '1234567' + ``` Gets the release with the ID '1234567' for the repository 'hello-world' owned by 'octocat'. diff --git a/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 b/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 index 7577e5c7e..b7fcece3a 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseByTagName { +filter Get-GitHubReleaseByTagName { <# .SYNOPSIS Get a release by tag name @@ -7,7 +7,9 @@ Get a published release with the specified tag. .EXAMPLE + ```pwsh Get-GitHubReleaseByTagName -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' + ``` Gets the release with the tag 'v1.0.0' for the repository 'hello-world' owned by 'octocat'. diff --git a/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 b/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 index 221afdbb1..84cedbcc0 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseLatest { +filter Get-GitHubReleaseLatest { <# .SYNOPSIS Get the latest release @@ -9,7 +9,9 @@ The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. .EXAMPLE + ```pwsh Get-GitHubReleaseLatest -Owner 'octocat' -Repository 'hello-world' + ``` Gets the latest releases for the repository 'hello-world' owned by 'octocat'. diff --git a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 index 64dad648a..ac222bec8 100644 --- a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 +++ b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryAutolinkById { +filter Get-GitHubRepositoryAutolinkById { <# .SYNOPSIS Get an autolink reference of a repository @@ -9,7 +9,9 @@ Information about autolinks are only available to repository administrators. .EXAMPLE + ```pwsh Get-GitHubRepositoryAutolinkById -Owner 'octocat' -Repository 'Hello-World' -ID 1 + ``` Gets the autolink with the ID 1 for the repository 'Hello-World' owned by 'octocat'. diff --git a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 index cda80c94d..7d349cb42 100644 --- a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 +++ b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryAutolinkList { +filter Get-GitHubRepositoryAutolinkList { <# .SYNOPSIS List all autolinks of a repository @@ -9,7 +9,9 @@ Information about autolinks are only available to repository administrators. .EXAMPLE + ```pwsh Get-GitHubRepositoryAutolinkList -Owner 'octocat' -Repository 'Hello-World' + ``` Gets all autolinks for the repository 'Hello-World' owned by 'octocat'. diff --git a/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 b/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 index f79bdc32e..12cc474a2 100644 --- a/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 +++ b/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyRepositories { +filter Get-GitHubMyRepositories { <# .SYNOPSIS List repositories for the authenticated user. @@ -9,12 +9,16 @@ they are a collaborator, and repositories that they can access through an organization membership. .EXAMPLE + ```pwsh Get-GitHubMyRepositories + ``` Gets the repositories for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubMyRepositories -Visibility 'private' + ``` Gets the private repositories for the authenticated user. diff --git a/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 b/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 index 14d125396..dcd9ba4fa 100644 --- a/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 +++ b/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyRepositoryByName { +filter Get-GitHubMyRepositoryByName { <# .SYNOPSIS List repositories for the authenticated user. @@ -9,7 +9,9 @@ they are a collaborator, and repositories that they can access through an organization membership. .EXAMPLE + ```pwsh Get-GitHubMyRepositoryByName + ``` Gets the repositories for the authenticated user. diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 index 06d6cd896..2e5c8689c 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryByName { +filter Get-GitHubRepositoryByName { <# .SYNOPSIS Get a repository @@ -11,7 +11,9 @@ For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." .EXAMPLE + ```pwsh Get-GitHubRepositoryByName -Owner 'octocat' -Name 'Hello-World' + ``` Gets the repository 'Hello-World' for the organization 'octocat'. diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 index 594ed1ed8..d04154104 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryByNameAndTeam { +filter Get-GitHubRepositoryByNameAndTeam { <# .SYNOPSIS Get the permission level for a team on a repository. @@ -7,10 +7,12 @@ Retrieves the permission level assigned to a specific team for a given GitHub repository. .EXAMPLE + ```pwsh Get-GitHubRepositoryByNameAndTeam -Owner 'octocat' -Name 'Hello-World' -Team 'core' + ``` Output: - ```powershell + ```pwsh ``` diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 index 6476885ec..14dce1547 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryListByOwner { +filter Get-GitHubRepositoryListByOwner { <# .SYNOPSIS List repositories for a user @@ -8,17 +8,23 @@ Note: For GitHub AE, this endpoint will list internal repositories for the specified user. .EXAMPLE + ```pwsh Get-GitHubRepositoryListByOwner -Owner 'octocat' + ``` Gets the repositories for the user 'octocat'. .EXAMPLE + ```pwsh Get-GitHubRepositoryListByOwner -Owner 'octocat' -Type 'member' + ``` Gets the repositories of organizations where the user 'octocat' is a member. .EXAMPLE + ```pwsh Get-GitHubRepositoryListByOwner -Owner 'octocat' -Sort 'created' -Direction 'asc' + ``` Gets the repositories for the user 'octocat' sorted by creation date in ascending order. diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 index 95e2c9238..b20c808e7 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryListByTeam { +filter Get-GitHubRepositoryListByTeam { <# .SYNOPSIS List team repositories. @@ -7,10 +7,12 @@ Lists a team's repositories visible to the authenticated user. .EXAMPLE + ```pwsh Get-GitHubRepositoryListByTeam -Owner 'octocat' -Team 'core' + ``` Output: - ```powershell + ```pwsh ``` Lists all repositories that the 'core' team has access to in the organization owned by 'octocat'. diff --git a/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 index b29c11f2a..1e0be15ee 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryAsFork { +filter New-GitHubRepositoryAsFork { <# .SYNOPSIS Create a fork @@ -13,23 +13,31 @@ repositories and on the source account with access to the source repository. .EXAMPLE + ```pwsh New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' + ``` Fork the repository `Hello-World` owned by `github` for the authenticated user. Repo will be named `Hello-World`, and all branches and tags will be forked. .EXAMPLE + ```pwsh New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' -Name 'Hello-World-2' + ``` Fork the repository `Hello-World` owned by `github` for the authenticated user, naming the resulting repository `Hello-World-2`. .EXAMPLE + ```pwsh New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' -Owner 'octocat' + ``` Fork the repository `Hello-World` owned by `github` for the organization `octocat`, naming the resulting repository `Hello-World`. .EXAMPLE + ```pwsh New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' -IncludeAllBranches + ``` Fork the repository `Hello-World` owned by `github` for the authenticated user, including all the branches from the source. diff --git a/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 index 388483be0..ce482be2e 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryFromTemplate { +filter New-GitHubRepositoryFromTemplate { <# .SYNOPSIS Create a repository using a template @@ -18,6 +18,7 @@ * `repo` scope to create a private repository .EXAMPLE + ```pwsh $params = @{ TemplateOwner = 'GitHub' TemplateRepository = 'octocat' @@ -28,6 +29,7 @@ Private = $true } New-GitHubRepositoryFromTemplate @params + ``` Creates a new private repository named `MyNewRepo` from the `octocat` template repository owned by `GitHub`. diff --git a/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 index 8a4b91906..16a9b2a42 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryOrg { +filter New-GitHubRepositoryOrg { <# .SYNOPSIS Create an organization repository @@ -14,6 +14,7 @@ * `repo` scope to create a private repository .EXAMPLE + ```pwsh $params = @{ Owner = 'PSModule' Name = 'Hello-World' @@ -31,6 +32,7 @@ SquashMergeCommitMessage = 'PR_BODY' } New-GitHubRepositoryOrg @params + ``` Creates a new public repository named "Hello-World" owned by the organization "PSModule". diff --git a/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 index fbfaf3406..bca83407a 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryUser { +filter New-GitHubRepositoryUser { <# .SYNOPSIS Create a repository for the authenticated user @@ -14,6 +14,7 @@ * `repo` scope to create a private repository. .EXAMPLE + ```pwsh $params = @{ Name = 'Hello-World' Description = 'This is your first repository' @@ -30,6 +31,7 @@ SquashMergeCommitMessage = 'PR_BODY' } New-GitHubRepositoryUser @params + ``` Creates a new public repository named "Hello-World" owned by the authenticated user. diff --git a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 index 9e80908b9..84c4f78ab 100644 --- a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 +++ b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryRuleSuiteById { +filter Get-GitHubRepositoryRuleSuiteById { <# .SYNOPSIS Get a repository rule suite @@ -8,7 +8,9 @@ For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." .EXAMPLE + ```pwsh Get-GitHubRepositoryRuleSuiteById -Owner 'octocat' -Repository 'hello-world' -RuleSuiteId 123456789 + ``` Gets information about a suite of rule evaluations with ID 123456789 from within the octocat/hello-world repository. diff --git a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 index 629992264..67493c4e6 100644 --- a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 +++ b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryRuleSuiteList { +filter Get-GitHubRepositoryRuleSuiteList { <# .SYNOPSIS List repository rule suites @@ -8,6 +8,7 @@ For more information, see"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repo = 'hello-world' @@ -17,6 +18,7 @@ RuleSuiteResult = 'all' } Get-GitHubRepositoryRuleSuiteList @params + ``` Gets a list of rule suites for the main branch of the hello-world repository owned by octocat. diff --git a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 index 669765d48..65d25ad36 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretEnvironmentByName { +function Get-GitHubSecretEnvironmentByName { <# .SYNOPSIS Get an environment secret. @@ -8,10 +8,12 @@ create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubSecretEnvironmentByName -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'SECRET1' -Context $GitHubContext + ``` Output: - ```powershell + ```pwsh Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 index 6f63d6c15..f84dd8bff 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretEnvironmentList { +function Get-GitHubSecretEnvironmentList { <# .SYNOPSIS List environment secrets. @@ -9,10 +9,12 @@ endpoint. .EXAMPLE + ```pwsh Get-GitHubSecretEnvironmentList -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Context $GitHubContext + ``` Output: - ```powershell + ```pwsh Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 b/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 index 67df30aa0..7f46446a7 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretFromOrganization { +function Get-GitHubSecretFromOrganization { <# .SYNOPSIS List repository organization secrets. @@ -9,10 +9,12 @@ this endpoint. .EXAMPLE + ```pwsh Get-GitHubSecretFromOrganization -Owner 'octocat' -Repository 'helloworld' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : SECRET1 Owner : octocat Repository : diff --git a/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 index 97179d7fe..62a404112 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretOwnerByName { +function Get-GitHubSecretOwnerByName { <# .SYNOPSIS Create or update an organization secret. @@ -12,10 +12,12 @@ the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubSecretOwnerByName -Owner 'octocat' -Name 'SECRET_THING' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : SECRET_THING Owner : octocat Repository : diff --git a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 index 0289fb8ea..ec3567c82 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretOwnerList { +function Get-GitHubSecretOwnerList { <# .SYNOPSIS List organization secrets. @@ -9,10 +9,12 @@ endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE + ```pwsh Get-GitHubSecretOwnerList -Owner 'PSModule' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh ``` Retrieves all secrets from the specified organization. diff --git a/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 index 19ddfba4e..a322acf90 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretRepositoryByName { +function Get-GitHubSecretRepositoryByName { <# .SYNOPSIS Get a repository secret. @@ -8,10 +8,12 @@ to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubSecretRepositoryByName -Owner 'octocat' -Repository 'Hello-World' -Name 'SECRET1' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 index 26501bd19..4f32140ff 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretRepositoryList { +function Get-GitHubSecretRepositoryList { <# .SYNOPSIS List repository secrets. @@ -9,10 +9,12 @@ endpoint. .EXAMPLE + ```pwsh Get-GitHubSecretRepositoryList -Owner 'octocat' -Repository 'Hello-World' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 index 0c0977b76..573011641 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForActionOnEnvironment { +function Get-GitHubPublicKeyForActionOnEnvironment { <# .SYNOPSIS Get an environment public key. @@ -9,10 +9,12 @@ access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubPublicKeyForActionOnEnvironment -Owner 'octocat' -Repository 'hello-world' -Environment 'prod' -Context $GitHubContext + ``` Outputs: - ```powershell + ```pwsh ID : 3380204578043523366 Key : ypK8XbFOtcXsCaqJOfdWjpCNumPmF3sfAbbv7x+3uSE= #gitleaks:allow Type : actions diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 index 6f6d799a8..4824a61ad 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForActionOnOrganization { +function Get-GitHubPublicKeyForActionOnOrganization { <# .SYNOPSIS Get an organization public key. @@ -10,10 +10,12 @@ need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubPublicKeyForActionOnOrganization -Owner 'octocat' -Context $GitHubContext + ``` Outputs: - ```powershell + ```pwsh ID : 3380204578043523366 Key : hwzclrjNNtZxYby19+0fiG7LazGFZxaM1IEbB25fkwo= #gitleaks:allow Type : actions diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 index 7812b8754..8704a9384 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForActionOnRepository { +function Get-GitHubPublicKeyForActionOnRepository { <# .SYNOPSIS Get a repository public key. @@ -9,10 +9,12 @@ the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubPublicKeyForActionOnRepository -Owner 'octocat' -Repository 'hello-world' -Context $GitHubContext + ``` Outputs: - ```powershell + ```pwsh ID : 3380204578043523366 Key : WkwZZ0xWbxZMqWrfUxLgvnALbrfdZSWxrhBcfTKshDY= #gitleaks:allow Type : actions diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 index f93081abe..e883596dd 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForCodespacesOnOrganization { +function Get-GitHubPublicKeyForCodespacesOnOrganization { <# .SYNOPSIS Get an organization public key. @@ -8,10 +8,12 @@ can create or update secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubPublicKeyForCodespacesOnOrganization -Owner 'octocat' -Context $GitHubContext + ``` Outputs: - ```powershell + ```pwsh ID : 3380189982652154440 Key : XbfD9j2CNq6L2qq2xpYrRhRRdFgR0CzfISQqsAIInGE= #gitleaks:allow Type : codespaces diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 index a3ee90088..1d5b5344a 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForCodespacesOnRepository { +function Get-GitHubPublicKeyForCodespacesOnRepository { <# .SYNOPSIS Get a repository public key. @@ -8,10 +8,12 @@ repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubPublicKeyForCodespacesOnRepository -Owner 'octocat' -Repository 'hello-world' -Context $GitHubContext + ``` Outputs: - ```powershell + ```pwsh ID : 3380189982652154440 Key : xPliIrAsVlPub63sB1cnvx/CKt5FGb5rjlbF7uHC+hM= #gitleaks:allow Type : codespaces diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 index 27eb34411..4fa847e5c 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForCodespacesOnUser { +function Get-GitHubPublicKeyForCodespacesOnUser { <# .SYNOPSIS Get public key for the authenticated user. @@ -9,10 +9,12 @@ OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubPublicKeyForCodespacesOnUser -Context $GitHubContext + ``` Outputs: - ```powershell + ```pwsh ID : 3380189982652154440 Key : dpr7ea5wmASt3ewAYNR/wPiPd6qakxN0060jdBmun0Y= #gitleaks:allow Type : codespaces diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 index a7838c887..22da5abec 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretFromEnvironment { +function Remove-GitHubSecretFromEnvironment { <# .SYNOPSIS Delete an environment secret. @@ -8,7 +8,9 @@ or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Remove-GitHubSecretFromEnvironment -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'SECRET1' -Context $GitHubContext + ``` Deletes the specified secret from the specified environment. diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 index 7cdb07809..d21e4e924 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretFromOwner { +function Remove-GitHubSecretFromOwner { <# .SYNOPSIS Delete an organization secret. @@ -9,7 +9,9 @@ is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Remove-GitHubSecretFromOwner -Owner 'octocat' -Name 'HOST_NAME' -Context $GitHubContext + ``` Deletes the specified secret from the specified organization. diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 index a6cce0757..46913ee03 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretFromRepository { +function Remove-GitHubSecretFromRepository { <# .SYNOPSIS Delete a repository secret. @@ -8,7 +8,9 @@ or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Remove-GitHubSecretFromRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'SECRET1' -Context $GitHubContext + ``` Deletes the specified secret from the specified repository. diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 index 1631f4c88..7db7603aa 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretOnEnvironment { +function Set-GitHubSecretOnEnvironment { <# .SYNOPSIS Create or update an environment secret. @@ -11,6 +11,7 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repository = 'Hello-World' @@ -20,6 +21,7 @@ Context = $GitHubContext } Set-GitHubSecretOnEnvironment @params + ``` Creates a new environment secret named `SECRET1` with the value `secret_value` in the specified environment. diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 index 705c87672..c4cd3893c 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretOnOwner { +function Set-GitHubSecretOnOwner { <# .SYNOPSIS Create or update an organization secret. @@ -12,7 +12,9 @@ the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Set-GitHubSecretOnOwner -Owner 'octocat' -Name 'HOST_NAME' -Value 'test_value' -Context $GitHubContext + ``` Creates a new organization secret named `HOST_NAME` with the value `test_value` in the specified organization. diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 index 4ae7efdb1..237b04d1c 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretOnRepository { +function Set-GitHubSecretOnRepository { <# .SYNOPSIS Create or update a repository secret. @@ -11,7 +11,9 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Set-GitHubSecretOnRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'SECRET1' -Value 'SECRET_VALUE' -Context $GitHubContext + ``` Creates a new repository secret named `SECRET1` with the value `SECRET_VALUE` in the specified repository. diff --git a/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 b/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 index 0b4b10245..e2c69ef1f 100644 --- a/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubTeamBySlug { +function Get-GitHubTeamBySlug { <# .SYNOPSIS Get a team by name @@ -8,7 +8,9 @@ and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name. .EXAMPLE + ```pwsh Get-GitHubTeamBySlug -Organization 'github' -Slug 'my-team-name' + ``` .NOTES [Get a team by name](https://docs.github.com/rest/teams/teams#get-a-team-by-name) diff --git a/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 b/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 index 7060a63c8..759aa73ca 100644 --- a/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubTeamListByOrg { +function Get-GitHubTeamListByOrg { <# .SYNOPSIS List teams @@ -7,7 +7,9 @@ Lists all teams in an organization that are visible to the authenticated user. .EXAMPLE + ```pwsh Get-GitHubTeamListByOrg -Organization 'github' + ``` .OUTPUTS GitHubTeam[] diff --git a/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 b/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 index f01f277f1..401b0c3ca 100644 --- a/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubTeamListByRepo { +filter Get-GitHubTeamListByRepo { <# .SYNOPSIS List repository teams. @@ -10,10 +10,12 @@ and repo scope to use this endpoint with a private repository. .EXAMPLE + ```pwsh Get-GitHubTeamListByRepo -Owner 'octocat' -Repository 'Hello-World' + ``` Output: - ```powershell + ```pwsh ``` diff --git a/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 b/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 index 5333cc35a..c38ddaf00 100644 --- a/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Block-GitHubUserByUser { +filter Block-GitHubUserByUser { <# .SYNOPSIS Block a user @@ -7,7 +7,9 @@ Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. .EXAMPLE + ```pwsh Block-GitHubUserByUser -Username 'octocat' + ``` Blocks the user 'octocat' for the authenticated user. Returns $true if successful, $false if not. diff --git a/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 index 617a42038..f429e51ff 100644 --- a/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBlockedUserByUser { +filter Get-GitHubBlockedUserByUser { <# .SYNOPSIS List users blocked by the authenticated user @@ -7,7 +7,9 @@ List the users you've blocked on your personal account. .EXAMPLE + ```pwsh Get-GitHubBlockedUserByUser + ``` Returns a list of users blocked by the authenticated user. diff --git a/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 index ee8eaf8ff..084a15a49 100644 --- a/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubBlockedUserByUser { +filter Test-GitHubBlockedUserByUser { <# .SYNOPSIS Check if a user is blocked by the authenticated user @@ -9,7 +9,9 @@ or if the given user account has been identified as spam by GitHub. .EXAMPLE + ```pwsh Test-GitHubBlockedUserByUser -Username 'octocat' + ``` Checks if the user `octocat` is blocked by the authenticated user. Returns true if the user is blocked, false if not. diff --git a/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 b/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 index f4270adc8..fa912aac0 100644 --- a/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Unblock-GitHubUserByUser { +filter Unblock-GitHubUserByUser { <# .SYNOPSIS Unblock a user @@ -7,7 +7,9 @@ Unblocks the given user and returns a 204. .EXAMPLE + ```pwsh Unblock-GitHubUserByUser -Username 'octocat' + ``` Unblocks the user 'octocat' for the authenticated user. Returns $true if successful. diff --git a/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 index 7a1167828..fd17873d6 100644 --- a/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 +++ b/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserAllEmail { +filter Get-GitHubUserAllEmail { <# .SYNOPSIS List email addresses for the authenticated user @@ -8,7 +8,9 @@ This endpoint is accessible with the `user:email` scope. .EXAMPLE + ```pwsh Get-GitHubUserAllEmail + ``` Gets all email addresses for the authenticated user. diff --git a/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 index f5e67b6f0..8f7dcb188 100644 --- a/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 +++ b/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserPublicEmail { +filter Get-GitHubUserPublicEmail { <# .SYNOPSIS List public email addresses for the authenticated user @@ -9,7 +9,9 @@ endpoint. This endpoint is accessible with the `user:email` scope. .EXAMPLE + ```pwsh Get-GitHubUserPublicEmail + ``` Gets all public email addresses for the authenticated user. diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 index abd3a7431..b82281d53 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowersOfUser { +filter Get-GitHubUserFollowersOfUser { <# .SYNOPSIS List followers of a user @@ -7,7 +7,9 @@ Lists the people following the specified user. .EXAMPLE + ```pwsh Get-GitHubUserFollowersOfUser -Username 'octocat' + ``` Gets all followers of user 'octocat'. diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 index 15509b6cc..583a846f5 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowingMe { +filter Get-GitHubUserFollowingMe { <# .SYNOPSIS List the people the authenticated user follows @@ -7,7 +7,9 @@ Lists the people who the authenticated user follows. .EXAMPLE + ```pwsh Get-GitHubUserFollowingMe + ``` Gets all people the authenticated user follows. diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 index c75ff3e0b..34bb0e657 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowingUser { +filter Get-GitHubUserFollowingUser { <# .SYNOPSIS List the people a user follows @@ -7,7 +7,9 @@ Lists the people who the specified user follows. .EXAMPLE + ```pwsh Get-GitHubUserFollowingUser -Username 'octocat' + ``` Gets all people that 'octocat' follows. diff --git a/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 index e2244e1d7..aa007cb54 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyFollower { +filter Get-GitHubUserMyFollower { <# .SYNOPSIS List followers of the authenticated user @@ -7,7 +7,9 @@ Lists the people following the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserMyFollowers + ``` Gets all followers of the authenticated user. diff --git a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 index c196d68c8..c0a7e68d0 100644 --- a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 +++ b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubUserFollowedByMe { +filter Test-GitHubUserFollowedByMe { <# .SYNOPSIS Check if a person is followed by the authenticated user @@ -8,7 +8,9 @@ Returns a 404 if the user is not followed by the authenticated user. .EXAMPLE + ```pwsh Test-GitHubUserFollowedByMe -Username 'octocat' + ``` Checks if the authenticated user follows the user 'octocat'. diff --git a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 index 56ab102f8..11b1db3b3 100644 --- a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 +++ b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubUserFollowedByUser { +filter Test-GitHubUserFollowedByUser { <# .SYNOPSIS Check if a user follows another user @@ -7,7 +7,9 @@ Checks if a user follows another user. .EXAMPLE + ```pwsh Test-GitHubUserFollowedByUser -Username 'octocat' -Follows 'ratstallion' + ``` Checks if the user 'octocat' follows the user 'ratstallion'. diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 index 826bc9d9b..758a57564 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserGpgKeyForUser { +filter Get-GitHubUserGpgKeyForUser { <# .SYNOPSIS List GPG keys for a user @@ -7,7 +7,9 @@ Lists the GPG keys for a user. This information is accessible by anyone. .EXAMPLE + ```pwsh Get-GitHubUserGpgKeyForUser -Username 'octocat' + ``` Gets all GPG keys for the 'octocat' user. diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 index 6b9ecbde3..92cba58f9 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyGpgKey { +filter Get-GitHubUserMyGpgKey { <# .SYNOPSIS List GPG keys for the authenticated user @@ -9,7 +9,9 @@ [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Get-GitHubUserMyGpgKey + ``` Gets all GPG keys for the authenticated user. diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 index 62594cd6e..6e31a96bd 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyGpgKeyById { +filter Get-GitHubUserMyGpgKeyById { <# .SYNOPSIS Get a GPG key for the authenticated user @@ -9,7 +9,9 @@ [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Get-GitHubUserMyGpgKeyById -ID '1234567' + ``` Gets the GPG key with ID '1234567' for the authenticated user. diff --git a/src/functions/private/Users/Get-GitHubAllUser.ps1 b/src/functions/private/Users/Get-GitHubAllUser.ps1 index 4d5f3c849..7faa4f3c9 100644 --- a/src/functions/private/Users/Get-GitHubAllUser.ps1 +++ b/src/functions/private/Users/Get-GitHubAllUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAllUser { +filter Get-GitHubAllUser { <# .SYNOPSIS List users @@ -11,7 +11,9 @@ to get the URL for the next page of users. .EXAMPLE + ```pwsh Get-GitHubAllUser -Since 17722253 + ``` Get a list of users, starting with the user 'MariusStorhaug'. diff --git a/src/functions/private/Users/Get-GitHubMyUser.ps1 b/src/functions/private/Users/Get-GitHubMyUser.ps1 index af5308aed..c5e01c6c7 100644 --- a/src/functions/private/Users/Get-GitHubMyUser.ps1 +++ b/src/functions/private/Users/Get-GitHubMyUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyUser { +filter Get-GitHubMyUser { <# .SYNOPSIS Get the authenticated user @@ -10,7 +10,9 @@ profile information. .EXAMPLE + ```pwsh Get-GitHubMyUser + ``` Get the authenticated user diff --git a/src/functions/private/Users/Get-GitHubUserByName.ps1 b/src/functions/private/Users/Get-GitHubUserByName.ps1 index ae3e644af..4fd226c95 100644 --- a/src/functions/private/Users/Get-GitHubUserByName.ps1 +++ b/src/functions/private/Users/Get-GitHubUserByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserByName { +filter Get-GitHubUserByName { <# .SYNOPSIS Get a user @@ -18,7 +18,9 @@ For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". .EXAMPLE + ```pwsh Get-GitHubUserByName -Name 'octocat' + ``` Get the 'octocat' user. diff --git a/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 index 2bab33bb4..8250a4bf9 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserKeyForUser { +filter Get-GitHubUserKeyForUser { <# .SYNOPSIS List public SSH keys for a user @@ -7,7 +7,9 @@ Lists the _verified_ public SSH keys for a user. This is accessible by anyone. .EXAMPLE + ```pwsh Get-GitHubUserKeyForUser -Username 'octocat' + ``` Gets all public SSH keys for the 'octocat' user. diff --git a/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 index 305e86323..3bd18437a 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyKey { +filter Get-GitHubUserMyKey { <# .SYNOPSIS List public SSH keys for the authenticated user @@ -9,7 +9,9 @@ [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Get-GitHubUserMyKey + ``` Gets all public SSH keys for the authenticated user. diff --git a/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 index 41e32fb4a..b7023ce5e 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyKeyById { +filter Get-GitHubUserMyKeyById { <# .SYNOPSIS Get a public SSH key for the authenticated user @@ -9,7 +9,9 @@ [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Get-GitHubUserMyKeyById -ID '1234567' + ``` Gets the public SSH key with the ID '1234567' for the authenticated user. diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 index a74b4ea19..1e50d513e 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMySigningKey { +filter Get-GitHubUserMySigningKey { <# .SYNOPSIS List SSH signing keys for the authenticated user @@ -9,7 +9,9 @@ "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE + ```pwsh Get-GitHubUserMySigningKey + ``` Lists the SSH signing keys for the authenticated user's GitHub account. diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 index c2571f0e5..d912fc9e1 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMySigningKeyById { +filter Get-GitHubUserMySigningKeyById { <# .SYNOPSIS Get an SSH signing key for the authenticated user @@ -10,7 +10,9 @@ "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE + ```pwsh Get-GitHubUserMySigningKeyById -ID '1234567' + ``` Gets the SSH signing key with the ID '1234567' for the authenticated user. diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 index b17735e9e..e4b7d3884 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserSigningKeyForUser { +filter Get-GitHubUserSigningKeyForUser { <# .SYNOPSIS List SSH signing keys for a user @@ -7,7 +7,9 @@ List SSH signing keys for a user .EXAMPLE + ```pwsh Get-GitHubUserSigningKeyForUser -Username 'octocat' + ``` Gets the SSH signing keys for the user 'octocat'. diff --git a/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 b/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 index 1f4eee04f..fa9abe237 100644 --- a/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 +++ b/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyUserSocials { +filter Get-GitHubMyUserSocials { <# .SYNOPSIS List social accounts for the authenticated user @@ -7,7 +7,9 @@ Lists all of your social accounts. .EXAMPLE + ```pwsh Get-GitHubMyUserSocials + ``` Lists all of your social accounts. diff --git a/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 b/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 index acaea233b..c19177063 100644 --- a/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 +++ b/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserSocialsByName { +filter Get-GitHubUserSocialsByName { <# .SYNOPSIS List social accounts for a user @@ -7,7 +7,9 @@ Lists social media accounts for a user. This endpoint is accessible by anyone. .EXAMPLE + ```pwsh Get-GitHubUserSocialsByName -Username 'octocat' + ``` Lists social media accounts for the user 'octocat'. diff --git a/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 b/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 index f67f07813..e77426775 100644 --- a/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 +++ b/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 @@ -1,4 +1,4 @@ -function Get-FunctionParameter { +function Get-FunctionParameter { <# .SYNOPSIS Get the parameters and their final value in a function. @@ -9,17 +9,23 @@ If a parameter is not provided, it will attempt to retrieve the default value. .EXAMPLE + ```pwsh Get-FunctionParameter + ``` This will return all the parameters and their final value in the current function. .EXAMPLE + ```pwsh Get-FunctionParameter -IncludeCommonParameters + ``` This will return all the parameters and their final value in the current function, including common parameters. .EXAMPLE + ```pwsh Get-FunctionParameter -Scope 2 + ``` This will return all the parameters and their final value in the grandparent function. #> diff --git a/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 b/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 index 8fe32f238..5dbee6571 100644 --- a/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 +++ b/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 @@ -1,4 +1,4 @@ -function Get-PSCallStackPath { +function Get-PSCallStackPath { <# .SYNOPSIS Create a string representation of the current call stack. @@ -10,21 +10,27 @@ and the last (the current function, Get-PSCallStackPath). .EXAMPLE + ```pwsh Get-PSCallStackPath First-Function\Second-Function\Third-Function + ``` Shows the call stack of the last function called, Third-Function, with the first () and last (Get-PSCallStackPath) functions removed. .EXAMPLE + ```pwsh Get-PSCallStackPath -SkipFirst 0 \First-Function\Second-Function\Third-Function + ``` Shows the call stack of the last function called, Third-Function, with the first function included (typically ). .EXAMPLE + ```pwsh Get-PSCallStackPath -SkipLatest 0 First-Function\Second-Function\Third-Function\Get-PSCallStackPath + ``` Shows the call stack of the last function called, Third-Function, with the last function included (Get-PSCallStackPath). #> diff --git a/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 b/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 index 54aa9cf2c..5794608cf 100644 --- a/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 +++ b/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 @@ -8,7 +8,9 @@ function Test-GitHubAzPowerShell { It verifies both the availability of the module and the authentication status. .EXAMPLE + ```pwsh Test-GitHubAzPowerShell + ``` Returns $true if Azure PowerShell module is installed and authenticated, $false otherwise. diff --git a/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 b/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 index 19a6db1f1..4cfb066e1 100644 --- a/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 +++ b/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 @@ -8,7 +8,9 @@ function Test-GitHubAzureCLI { It verifies both the availability of the CLI tool and the authentication status. .EXAMPLE + ```pwsh Test-GitHubAzureCLI + ``` Returns $true if Azure CLI is installed and authenticated, $false otherwise. diff --git a/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 index 69812c051..eb92fcf80 100644 --- a/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableEnvironmentByName { +function Get-GitHubVariableEnvironmentByName { <# .SYNOPSIS Retrieves a specific variable from a GitHub repository. @@ -9,10 +9,12 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubVariableEnvironmentByName -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'NAME' -Context $GitHubContext + ``` Output: - ```powershell + ```pwsh Name : NAME Value : John Doe Owner : octocat diff --git a/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 b/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 index a3241f63c..261ea9325 100644 --- a/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableEnvironmentList { +function Get-GitHubVariableEnvironmentList { <# .SYNOPSIS Retrieves all variables for a specified environment in a GitHub repository. @@ -9,10 +9,12 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubVariableEnvironmentList -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Context $GitHubContext + ``` Output: - ```powershell + ```pwsh Name : NAME Value : John Doe Owner : octocat diff --git a/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 b/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 index 74b0cd0b3..edc90b4fc 100644 --- a/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableFromOrganization { +function Get-GitHubVariableFromOrganization { <# .SYNOPSIS List repository organization variables. @@ -9,10 +9,12 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubVariableFromOrganization -Owner 'PSModule' -Repository 'GitHub' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : AVAILVAR Value : ValueVar Owner : PSModule diff --git a/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 index a222c70d7..b8978f529 100644 --- a/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableOwnerByName { +function Get-GitHubVariableOwnerByName { <# .SYNOPSIS Get an organization variable. @@ -10,10 +10,12 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubVariableOwnerByName -Owner 'PSModule' -Name 'SELECTEDVAR' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : SELECTEDVAR Value : Varselected Owner : PSModule diff --git a/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 b/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 index 892ad9eff..cc08b5ed7 100644 --- a/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableOwnerList { +function Get-GitHubVariableOwnerList { <# .SYNOPSIS List organization variables @@ -10,10 +10,12 @@ the `repo` scope is also required. .EXAMPLE + ```pwsh Get-GitHubVariableOwnerList -Owner 'PSModule' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : AVAILVAR Value : ValueVar Owner : PSModule diff --git a/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 index 20865a359..07b6e9d20 100644 --- a/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableRepositoryByName { +function Get-GitHubVariableRepositoryByName { <# .SYNOPSIS Get a repository variable @@ -9,10 +9,12 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubVariableRepositoryByName -Owner 'PSModule' -Repository 'Hello-World' -Name 'EMAIL' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : EMAIL Value : John.Doe@example.com Owner : octocat diff --git a/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 b/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 index d38e51eec..58f728fdd 100644 --- a/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableRepositoryList { +function Get-GitHubVariableRepositoryList { <# .SYNOPSIS List repository variables. @@ -9,10 +9,12 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubVariableRepositoryList -Owner 'PSModule' -Repository 'Hello-World' -Context (Get-GitHubContext) + ``` Output: - ```powershell + ```pwsh Name : NAME Value : John Doe Owner : octocat diff --git a/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 b/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 index 8b3f764ec..697a4ce4b 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariableOnEnvironment { +function New-GitHubVariableOnEnvironment { <# .SYNOPSIS Create an environment variable. @@ -9,6 +9,7 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repository = 'Hello-World' @@ -18,6 +19,7 @@ Context = $GitHubContext } New-GitHubVariableOnEnvironment @params + ``` Creates a new environment variable named `HOST_NAME` with the value `github.com` in the specified environment. diff --git a/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 b/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 index 5ba36f62e..658f915a6 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariableOnOwner { +function New-GitHubVariableOnOwner { <# .SYNOPSIS Create an organization variable. @@ -10,7 +10,9 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh New-GitHubVariableOnOwner -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Creates a new organization variable named `HOST_NAME` with the value `github.com` in the specified organization. diff --git a/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 b/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 index 32899700f..95c40b666 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariableOnRepository { +function New-GitHubVariableOnRepository { <# .SYNOPSIS Create a repository variable. @@ -9,7 +9,9 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh New-GitHubVariableOnRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Creates a new repository variable named `HOST_NAME` with the value `github.com` in the specified repository. diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 index f09b9fc8a..387e15adf 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableFromEnvironment { +function Remove-GitHubVariableFromEnvironment { <# .SYNOPSIS Delete an environment variable. @@ -9,7 +9,9 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Remove-GitHubVariableFromEnvironment -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Context $GitHubContext + ``` Deletes the specified variable from the specified environment. diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 index 885416444..21b70e378 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableFromOwner { +function Remove-GitHubVariableFromOwner { <# .SYNOPSIS Delete an organization variable. @@ -10,7 +10,9 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Remove-GitHubVariableFromOwner -Owner 'octocat' -Name 'HOST_NAME' -Context $GitHubContext + ``` Deletes the specified variable from the specified organization. diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 index 3822bb9ba..26a74c34f 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableFromRepository { +function Remove-GitHubVariableFromRepository { <# .SYNOPSIS Delete a repository variable. @@ -9,7 +9,9 @@ OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Remove-GitHubVariableFromRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Context $GitHubContext + ``` Deletes the specified variable from the specified repository. diff --git a/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 index 53a21c906..051c7a031 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariableOnEnvironment { +function Update-GitHubVariableOnEnvironment { <# .SYNOPSIS Update an environment variable. @@ -10,6 +10,7 @@ .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repository = 'Hello-World' @@ -19,6 +20,7 @@ Context = $GitHubContext } Update-GitHubVariableOnEnvironment @params + ``` Updates the environment variable named `HOST_NAME` with the value `github.com` in the specified environment. diff --git a/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 index 3463b8b87..dac9a0c51 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariableOnOwner { +function Update-GitHubVariableOnOwner { <# .SYNOPSIS Update an organization variable. @@ -10,7 +10,9 @@ the `repo` scope is also required. .EXAMPLE + ```pwsh Update-GitHubVariableOnOwner -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Updates the organization variable named `HOST_NAME` with the value `github.com` in the specified organization. diff --git a/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 index d35bd664e..b6e2dd252 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariableOnRepository { +function Update-GitHubVariableOnRepository { <# .SYNOPSIS Update a repository variable. @@ -9,7 +9,9 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Update-GitHubVariableOnRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Updates the repository variable named `HOST_NAME` with the value `github.com` in the specified repository. diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 index a9aab7b78..e2e4f30af 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDeliveryByID { +function Get-GitHubAppWebhookDeliveryByID { <# .SYNOPSIS Get a delivery for an app webhook @@ -11,7 +11,9 @@ .EXAMPLE + ```pwsh Get-GitHubAppWebhookDeliveryByID -ID 123456 + ``` Returns the webhook configuration for the authenticated app. diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 index 8f0dac867..966c4e837 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDeliveryByList { +function Get-GitHubAppWebhookDeliveryByList { <# .SYNOPSIS List deliveries for an app webhook @@ -10,7 +10,9 @@ to access this endpoint. .EXAMPLE + ```pwsh Get-GitHubAppWebhookDeliveryByList + ``` Returns the webhook configuration for the authenticated app. diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 index 957dad479..4765a307c 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDeliveryToRedeliver { +function Get-GitHubAppWebhookDeliveryToRedeliver { <# .SYNOPSIS Short description @@ -7,7 +7,9 @@ Long description .EXAMPLE + ```pwsh An example + ``` .NOTES [Ttle](link) diff --git a/src/functions/public/API/Invoke-GitHubAPI.ps1 b/src/functions/public/API/Invoke-GitHubAPI.ps1 index 2c4d9279b..dc2cd5f99 100644 --- a/src/functions/public/API/Invoke-GitHubAPI.ps1 +++ b/src/functions/public/API/Invoke-GitHubAPI.ps1 @@ -1,4 +1,4 @@ -#Requires -Modules @{ ModuleName = 'Uri'; RequiredVersion = '1.1.2' } +#Requires -Modules @{ ModuleName = 'Uri'; RequiredVersion = '1.1.2' } #Requires -Modules @{ ModuleName = 'Hashtable'; RequiredVersion = '1.1.6' } function Invoke-GitHubAPI { @@ -11,17 +11,23 @@ function Invoke-GitHubAPI { It automatically handles the endpoint URI construction, headers, and token authentication. .EXAMPLE + ```pwsh Invoke-GitHubAPI -ApiEndpoint '/repos/user/repo/pulls' -Method GET + ``` Gets all open pull requests for the specified repository. .EXAMPLE + ```pwsh Invoke-GitHubAPI -ApiEndpoint '/repos/user/repo/pulls' -Method GET -Body @{ state = 'open' } + ``` Gets all open pull requests for the specified repository, filtered by the 'state' parameter. .EXAMPLE + ```pwsh Invoke-GitHubAPI -ApiEndpoint '/repos/user/repo/pulls' -Method GET -Body @{ state = 'open' } -Accept 'application/vnd.github.v3+json' + ``` Gets all open pull requests for the specified repository, filtered by the 'state' parameter, and using the specified 'Accept' header. diff --git a/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 b/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 index 6da9cd426..5ef8eb993 100644 --- a/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 +++ b/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 @@ -1,4 +1,4 @@ -function Invoke-GitHubGraphQLQuery { +function Invoke-GitHubGraphQLQuery { <# .SYNOPSIS Invoke a GraphQL requests against the GitHub GraphQL API @@ -7,7 +7,9 @@ Use this function to invoke a GraphQL query and mutations against the GitHub GraphQL API with proper error handling. .EXAMPLE + ```pwsh Invoke-GitHubGraphQLQuery -Query $query -Variables $Variables + ``` .LINK https://psmodule.io/GitHub/Functions/API/Invoke-GitHubGraphQLQuery diff --git a/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 b/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 index 1bfedf23f..0b833be2e 100644 --- a/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 +++ b/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEventData { +function Get-GitHubEventData { <# .SYNOPSIS Gets data about the event that triggered the workflow. @@ -7,7 +7,9 @@ Gets data about the event that triggered the workflow. .EXAMPLE + ```pwsh Get-GitHubEventData + ``` .LINK https://psmodule.io/GitHub/Functions/Actions/Data/Get-GitHubEventData diff --git a/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 b/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 index 896d058e8..041a011dc 100644 --- a/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 +++ b/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubRunnerData { +function Get-GitHubRunnerData { <# .SYNOPSIS Gets data about the runner thats running the workflow. @@ -7,7 +7,9 @@ Gets data about the runner thats running the workflow. .EXAMPLE + ```pwsh Get-GitHubRunnerData + ``` .LINK https://psmodule.io/GitHub/Functions/Actions/Data/Get-GitHubRunnerData diff --git a/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 index b447032cb..82175c1b0 100644 --- a/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubAppInstallationRepositoryAccess { +function Add-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Grant repository access to an organization installation. @@ -7,6 +7,7 @@ Grant repository access to an organization installation. .EXAMPLE + ```pwsh $params = @{ Enterprise = 'msx' Organization = 'PSModule' @@ -14,6 +15,7 @@ Repositories = 'repo1', 'repo2' } Add-GitHubAppInstallationRepositoryAccess @params + ``` Grant access to the repositories 'repo1' and 'repo2' for the installation with the ID '12345678' on the organization 'PSModule' in the enterprise 'msx'. diff --git a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 index a884c9083..2b2614fbb 100644 --- a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppAccessibleRepository { +function Get-GitHubAppAccessibleRepository { <# .SYNOPSIS Get repositories belonging to an enterprise owned organization that can be made accessible to a GitHub App @@ -11,11 +11,13 @@ permission. .EXAMPLE + ```pwsh $params = @{ Enterprise = 'msx' Organization = 'PSModule' } Get-GitHubAppAccessibleRepository @params + ``` Get the repositories that can be made accessible to a GitHub App installed on the organization 'PSModule' in the enterprise 'msx'. diff --git a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 index 0c6423e19..cd428a778 100644 --- a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationRepositoryAccess { +function Get-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Get the repositories accessible to a given GitHub App installation. @@ -9,12 +9,14 @@ The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (read) permission. .EXAMPLE + ```pwsh $params = @{ Enterprise = 'msx' Organization = 'PSModule' InstallationID = 12345678 } Get-GitHubAppInstallationRepositoryAccess @params + ``` Get the repositories accessible to the GitHub App installation with the ID '12345678' on the organization 'PSModule' in the enterprise 'msx'. diff --git a/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 b/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 index 142f8370a..68c60ed0a 100644 --- a/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubAppInstallationAccessToken { +filter New-GitHubAppInstallationAccessToken { <# .SYNOPSIS Create an installation access token for an app @@ -28,13 +28,17 @@ to access this endpoint. .EXAMPLE + ```pwsh New-GitHubAppInstallationAccessToken -InstallationID 12345678 + ``` Creates an installation access token for the installation with the ID `12345678`. .EXAMPLE + ```pwsh Connect-GitHub -ClientID $ClientID -PrivateKey $PrivateKey Get-GitHubAppInstallation | New-GitHubAppInstallationAccessToken + ``` Gets the GitHub App installations and creates an installation access token for each installation. diff --git a/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 index 9c604ab1b..816410e92 100644 --- a/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubAppInstallationRepositoryAccess { +function Remove-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Remove repository access to an organization installation. @@ -7,6 +7,7 @@ Remove repository access to an organization installation. .EXAMPLE + ```pwsh $params = @{ Enterprise = 'msx' Organization = 'PSModule' @@ -14,6 +15,7 @@ Repositories = 'repo1', 'repo2' } Remove-GitHubAppInstallationRepositoryAccess @params + ``` Remove access to the repositories 'repo1' and 'repo2' for the installation with the ID '12345678' on the organization 'PSModule' in the enterprise 'msx'. diff --git a/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 index 58111e114..77e8f0aa7 100644 --- a/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubAppInstallationRepositoryAccess { +function Update-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Update the installation repository access between all repositories and selected repositories. @@ -7,12 +7,15 @@ Update repository access for a GitHub App installation between all repositories and selected repositories. .EXAMPLE + ```pwsh Update-GitHubAppInstallationRepositoryAccess -Enterprise 'msx' -Organization 'PSModule' -InstallationID 12345678 -RepositorySelection 'all' + ``` Update the repository access for the GitHub App installation with the ID '12345678' to all repositories on the organization 'PSModule' in the enterprise 'msx'. .EXAMPLE + ```pwsh $params = @{ Enterprise = 'msx' Organization = 'PSModule' @@ -21,6 +24,7 @@ Repositories = 'repo1', 'repo2' } Update-GitHubAppInstallationRepositoryAccess @params + ``` Update the repository access for the GitHub App installation with the ID '12345678' to the repositories 'repo1' and 'repo2' on the organization 'PSModule' in the enterprise 'msx'. diff --git a/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 index 521168d95..ab6c00f68 100644 --- a/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubApp { +filter Get-GitHubApp { <# .SYNOPSIS Get the authenticated app or a specific app by its slug. @@ -7,12 +7,16 @@ Returns a GitHub App associated with the authentication credentials used or the provided app-slug. .EXAMPLE + ```pwsh Get-GitHubApp + ``` Get the authenticated app. .EXAMPLE + ```pwsh Get-GitHubApp -Slug 'github-actions' + ``` Get the GitHub App with the slug 'github-actions'. diff --git a/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 b/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 index 7f9da82ce..0331aed9a 100644 --- a/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 +++ b/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAppInstallationRequest { +filter Get-GitHubAppInstallationRequest { <# .SYNOPSIS List installation requests for the authenticated app. @@ -7,7 +7,9 @@ Lists all the pending installation requests for the authenticated GitHub App. .EXAMPLE + ```pwsh Get-GitHubAppInstallationRequest + ``` Lists all the pending installation requests for the authenticated GitHub App. diff --git a/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 index d30dafe98..2fef6570d 100644 --- a/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 @@ -1,4 +1,4 @@ -function Install-GitHubApp { +function Install-GitHubApp { <# .SYNOPSIS Install an app @@ -7,7 +7,9 @@ Installs the provided GitHub App on the specified target. .EXAMPLE + ```pwsh Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'selected' -Repositories 'repo1', 'repo2' + ``` Install the GitHub App with - the client ID '123456' @@ -16,7 +18,9 @@ on the organization 'org' in the enterprise 'msx'. .EXAMPLE + ```pwsh Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'all' + ``` Install the GitHub App with - the client ID '123456' diff --git a/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 index 252ac503e..ce8031697 100644 --- a/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 @@ -1,4 +1,4 @@ -function Uninstall-GitHubApp { +function Uninstall-GitHubApp { <# .SYNOPSIS Uninstall a GitHub App. @@ -9,23 +9,31 @@ - As an enterprise installation (IAT/UAT context with Enterprise): remove an app from an organization by InstallationID or AppSlug. .EXAMPLE + ```pwsh Uninstall-GitHubApp -Target 'octocat' Uninstall-GitHubApp -Target 12345 + ``` As an App: uninstall by target name (enterprise/org/user) or by exact installation ID .EXAMPLE + ```pwsh Get-GitHubAppInstallation | Uninstall-GitHubApp + ``` As an App: uninstall using pipeline objects .EXAMPLE + ```pwsh Uninstall-GitHubApp -Organization 'org' -InstallationID 123456 -Context (Connect-GitHubApp -Enterprise 'msx' -PassThru) + ``` As an enterprise installation: uninstall by installation ID in an org .EXAMPLE + ```pwsh Uninstall-GitHubApp -Organization 'org' -AppSlug 'my-app' -Context (Connect-GitHubApp -Enterprise 'msx' -PassThru) + ``` As an enterprise installation: uninstall by app slug in an org diff --git a/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 index a7657facc..eb538032c 100644 --- a/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifact { +function Get-GitHubArtifact { <# .SYNOPSIS Retrieves GitHub Actions artifacts from a repository or workflow run. @@ -12,10 +12,12 @@ - FromRepository: Retrieve artifacts from a repository, optionally by name or with all versions. .EXAMPLE + ```pwsh Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -ID '123456' + ``` Output: - ```powershell + ```pwsh Name : artifact-1 ID : 123456 SizeInBytes : 2048 @@ -25,10 +27,12 @@ Retrieves a single GitHub Actions artifact using its unique artifact ID. .EXAMPLE + ```pwsh Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -WorkflowRunID '987654321' + ``` Output: - ```powershell + ```pwsh Name : test-results ID : 456789 SizeInBytes : 4096 @@ -38,10 +42,12 @@ Retrieves the latest version of all artifacts from the specified workflow run. .EXAMPLE + ```pwsh Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -WorkflowRunID '987654321' -AllVersions + ``` Output: - ```powershell + ```pwsh Name : test-results ID : 4564584673 SizeInBytes : 4096 @@ -56,10 +62,12 @@ Retrieves all versions of all artifacts from the specified workflow run. .EXAMPLE + ```pwsh Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' + ``` Output: - ```powershell + ```pwsh Name : build-artifact ID : 998877 SizeInBytes : 8192 diff --git a/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 index 747d32150..2b6a26025 100644 --- a/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 @@ -10,7 +10,9 @@ function Remove-GitHubArtifact { The function uses the GitHub REST API to perform the deletion and supports `ShouldProcess` for safe execution. .EXAMPLE + ```pwsh Remove-GitHubArtifact -Owner 'octocat' -Repository 'demo-repo' -ID '123456' + ``` Deletes the artifact with ID 123456 from the repository 'demo-repo' owned by 'octocat'. diff --git a/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 index 6c34f001d..acb71dcc5 100644 --- a/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 @@ -1,4 +1,4 @@ -function Save-GitHubArtifact { +function Save-GitHubArtifact { <# .SYNOPSIS Downloads a GitHub Actions artifact. @@ -9,10 +9,12 @@ personal access tokens (classic) or OAuth tokens with the `repo` scope are required. .EXAMPLE + ```pwsh Save-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -ID '123456' -Path 'C:\Artifacts' + ``` Output: - ```powershell + ```pwsh Directory: C:\Artifacts Mode LastWriteTime Length Name @@ -23,10 +25,12 @@ Downloads artifact ID '123456' from the 'Hello-World' repository owned by 'octocat' to the specified path. .EXAMPLE + ```pwsh Save-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -Name 'module' -Path 'C:\Artifacts\module' -Expand -Force + ``` Output: - ```powershell + ```pwsh Directory: C:\Artifacts Mode LastWriteTime Length Name diff --git a/src/functions/public/Auth/Connect-GitHubAccount.ps1 b/src/functions/public/Auth/Connect-GitHubAccount.ps1 index 8a371a922..9268325de 100644 --- a/src/functions/public/Auth/Connect-GitHubAccount.ps1 +++ b/src/functions/public/Auth/Connect-GitHubAccount.ps1 @@ -1,4 +1,4 @@ -function Connect-GitHubAccount { +function Connect-GitHubAccount { <# .SYNOPSIS Connects to GitHub. @@ -17,26 +17,34 @@ the app will be able to make API calls with a new access token. .EXAMPLE + ```pwsh Connect-GitHubAccount + ``` Connects to GitHub using a device flow login. If the user has already logged in, the access token will be refreshed. .EXAMPLE + ```pwsh $env:GH_TOKEN = '***' Connect-GitHubAccount + ``` Connects to GitHub using the access token from environment variable, assuming unattended mode. .EXAMPLE + ```pwsh Connect-GitHubAccount -UseAccessToken ! Enter your personal access token: ************* + ``` User gets prompted for the access token and stores it in the context. The token is used when connecting to GitHub. .EXAMPLE + ```pwsh Connect-GitHubAccount -Mode 'OAuthApp' -Scope 'gist read:org repo workflow' + ``` Connects to GitHub using a device flow login and sets the scope of the access token. diff --git a/src/functions/public/Auth/Connect-GitHubApp.ps1 b/src/functions/public/Auth/Connect-GitHubApp.ps1 index cb54b8513..f07e72c54 100644 --- a/src/functions/public/Auth/Connect-GitHubApp.ps1 +++ b/src/functions/public/Auth/Connect-GitHubApp.ps1 @@ -1,4 +1,4 @@ -function Connect-GitHubApp { +function Connect-GitHubApp { <# .SYNOPSIS Connects to GitHub as a installation using a GitHub App. @@ -12,22 +12,30 @@ - Enterprise .EXAMPLE + ```pwsh Connect-GitHubApp + ``` Connects to GitHub as all available targets using the logged in GitHub App. .EXAMPLE + ```pwsh Connect-GitHubApp -User 'octocat' + ``` Connects to GitHub as the user 'octocat' using the logged in GitHub App. .EXAMPLE + ```pwsh Connect-GitHubApp -Organization 'psmodule' -Default + ``` Connects to GitHub as the organization 'psmodule' using the logged in GitHub App and sets it as the default context. .EXAMPLE + ```pwsh Connect-GitHubApp -Enterprise 'msx' + ``` Connects to GitHub as the enterprise 'msx' using the logged in GitHub App. diff --git a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 b/src/functions/public/Auth/Context/Get-GitHubContext.ps1 index 03ff7be82..b00df00ee 100644 --- a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 +++ b/src/functions/public/Auth/Context/Get-GitHubContext.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubContext { +function Get-GitHubContext { <# .SYNOPSIS Get the current GitHub context. @@ -7,7 +7,9 @@ Get the current GitHub context. .EXAMPLE + ```pwsh Get-GitHubContext + ``` Gets the current GitHub context. diff --git a/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 b/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 index b4f7ed876..07fdf1cf7 100644 --- a/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 +++ b/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 @@ -1,4 +1,4 @@ -function Switch-GitHubContext { +function Switch-GitHubContext { <# .SYNOPSIS Set the default context. @@ -7,7 +7,9 @@ Set the default context for the GitHub module. .EXAMPLE + ```pwsh Switch-GitHubContext -Context 'github.com/Octocat' + ``` .LINK https://psmodule.io/GitHub/Functions/Auth/Context/Switch-GitHubContext diff --git a/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 b/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 index 32ce7a61a..a2d126e15 100644 --- a/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 +++ b/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 @@ -1,4 +1,4 @@ -function Disconnect-GitHubAccount { +function Disconnect-GitHubAccount { <# .SYNOPSIS Disconnects from GitHub and removes the GitHub context. @@ -8,22 +8,30 @@ to ensure it cannot be used after disconnection. .EXAMPLE + ```pwsh Disconnect-GitHubAccount + ``` Disconnects from GitHub and removes the default GitHub context. .EXAMPLE + ```pwsh Disconnect-GithubAccount -Context 'github.com/Octocat' + ``` Disconnects from GitHub and removes the context 'github.com/Octocat'. .EXAMPLE + ```pwsh Disconnect-GitHubAccount -RevokeToken + ``` Disconnects from GitHub, revokes the access token, and removes the default GitHub context. .EXAMPLE + ```pwsh Disconnect-GithubAccount -Context 'github.com/Octocat' -RevokeToken + ``` Disconnects from GitHub, revokes the access token, and removes the context 'github.com/Octocat'. diff --git a/src/functions/public/Auth/Get-GitHubAccessToken.ps1 b/src/functions/public/Auth/Get-GitHubAccessToken.ps1 index 97ead7bfa..5923dd459 100644 --- a/src/functions/public/Auth/Get-GitHubAccessToken.ps1 +++ b/src/functions/public/Auth/Get-GitHubAccessToken.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAccessToken { +function Get-GitHubAccessToken { <# .SYNOPSIS Retrieves the GitHub access token from the specified context. @@ -10,20 +10,24 @@ Use this function to extract authentication tokens for subsequent API requests. .EXAMPLE + ```pwsh Get-GitHubAccessToken + ``` Output: - ```powershell + ```pwsh System.Security.SecureString ``` Retrieves the access token from the default context as a secure string. .EXAMPLE + ```pwsh Get-GitHubAccessToken -Context $myGitHubContext -AsPlainText + ``` Output: - ```powershell + ```pwsh ghp_exampletoken1234567890 ``` diff --git a/src/functions/public/Auth/Get-GitHubViewer.ps1 b/src/functions/public/Auth/Get-GitHubViewer.ps1 index f5088adb9..2ffd71876 100644 --- a/src/functions/public/Auth/Get-GitHubViewer.ps1 +++ b/src/functions/public/Auth/Get-GitHubViewer.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubViewer { +function Get-GitHubViewer { <# .SYNOPSIS Gets the currently authenticated user. @@ -7,7 +7,9 @@ Gets the currently authenticated user. .EXAMPLE + ```pwsh Get-GithubViewer + ``` Gets the currently authenticated user. diff --git a/src/functions/public/Commands/Add-GitHubMask.ps1 b/src/functions/public/Commands/Add-GitHubMask.ps1 index faa80491e..98a36df47 100644 --- a/src/functions/public/Commands/Add-GitHubMask.ps1 +++ b/src/functions/public/Commands/Add-GitHubMask.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubMask { +filter Add-GitHubMask { <# .SYNOPSIS Masks a value in a log @@ -10,12 +10,16 @@ set that value as an output. .EXAMPLE + ```pwsh Add-Mask $SecretValue + ``` Masks the value of $SecretValue so that its printed like ***. .EXAMPLE + ```pwsh $SecretValue1, $SecretValue2 | Mask + ``` Masks the value of $SecretValue1 and $SecretValue2 so that its printed like ***, using the pipeline diff --git a/src/functions/public/Commands/Add-GitHubSystemPath.ps1 b/src/functions/public/Commands/Add-GitHubSystemPath.ps1 index 43ac36e1b..e43cfdba6 100644 --- a/src/functions/public/Commands/Add-GitHubSystemPath.ps1 +++ b/src/functions/public/Commands/Add-GitHubSystemPath.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubSystemPath { +function Add-GitHubSystemPath { <# .SYNOPSIS Adds a system path to the GitHub Actions environment @@ -9,7 +9,9 @@ echo "$env:PATH" in a step or an action. .EXAMPLE + ```pwsh Add-GitHubSystemPath -Path '$HOME/.local/bin' + ``` .NOTES [Adding a system path](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path) diff --git a/src/functions/public/Commands/Disable-GitHubCommand.ps1 b/src/functions/public/Commands/Disable-GitHubCommand.ps1 index edcbdefc3..3c421e863 100644 --- a/src/functions/public/Commands/Disable-GitHubCommand.ps1 +++ b/src/functions/public/Commands/Disable-GitHubCommand.ps1 @@ -1,4 +1,4 @@ -function Disable-GitHubCommand { +function Disable-GitHubCommand { <# .SYNOPSIS Stops workflow commands @@ -11,7 +11,9 @@ that you used to stop workflow commands to the Enable-GitHubCommand. .EXAMPLE + ```pwsh Disable-GitHubCommand "123" + ``` Stops processing any workflow commands. diff --git a/src/functions/public/Commands/Enable-GitHubCommand.ps1 b/src/functions/public/Commands/Enable-GitHubCommand.ps1 index b98b88a7b..d4dbfa0dd 100644 --- a/src/functions/public/Commands/Enable-GitHubCommand.ps1 +++ b/src/functions/public/Commands/Enable-GitHubCommand.ps1 @@ -1,4 +1,4 @@ -function Enable-GitHubCommand { +function Enable-GitHubCommand { <# .SYNOPSIS Resumes workflow commands @@ -10,7 +10,9 @@ that you used to stop workflow commands to the Enable-GitHubCommand. .EXAMPLE + ```pwsh Enable-GitHubCommand "123" + ``` Resumes processing any workflow commands. diff --git a/src/functions/public/Commands/Get-GitHubOutput.ps1 b/src/functions/public/Commands/Get-GitHubOutput.ps1 index f98bd00d9..5a660c9d9 100644 --- a/src/functions/public/Commands/Get-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Get-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubOutput { +function Get-GitHubOutput { <# .SYNOPSIS Gets the GitHub output. @@ -7,15 +7,19 @@ Gets the GitHub output from $env:GITHUB_OUTPUT and creates an object with key-value pairs, supporting both single-line and multi-line values .EXAMPLE + ```pwsh Get-GitHubOutput MY_VALUE result zen -------- ------ --- qwe… @{"MyOutput":"Hello, World!"} something else + ``` Gets the GitHub output and returns an object with key-value pairs. .EXAMPLE + ```pwsh Get-GitHubOutput -AsHashtable + ``` Name Value ---- ----- diff --git a/src/functions/public/Commands/Reset-GitHubOutput.ps1 b/src/functions/public/Commands/Reset-GitHubOutput.ps1 index 3d96eaa4d..30d88a7c5 100644 --- a/src/functions/public/Commands/Reset-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Reset-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -function Reset-GitHubOutput { +function Reset-GitHubOutput { <# .SYNOPSIS Resets the GitHub output. @@ -7,7 +7,9 @@ Resets the GitHub output by clearing the contents of $env:GITHUB_OUTPUT. .EXAMPLE + ```pwsh Reset-GitHubOutput + ``` Resets the content in the GitHub output file. diff --git a/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 b/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 index db103b5f7..556156cfd 100644 --- a/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 +++ b/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubEnvironmentVariable { +function Set-GitHubEnvironmentVariable { <# .SYNOPSIS Setting an environment variable @@ -7,7 +7,9 @@ Set a GitHub environment variable .EXAMPLE + ```pwsh Set-GitHubEnv -Name 'MyVariable' -Value 'MyValue' + ``` .NOTES [Setting an environment variable](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable) diff --git a/src/functions/public/Commands/Set-GitHubLogGroup.ps1 b/src/functions/public/Commands/Set-GitHubLogGroup.ps1 index 0031282de..558629065 100644 --- a/src/functions/public/Commands/Set-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Set-GitHubLogGroup.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubLogGroup { +function Set-GitHubLogGroup { <# .SYNOPSIS Encapsulates commands with a log group in GitHub Actions @@ -8,16 +8,20 @@ Allows for colapsing of code in IDE for code that belong together. .EXAMPLE + ```pwsh Set-GitHubLogGroup -Name 'MyGroup' -ScriptBlock { Write-Host 'Hello, World!' } + ``` Creates a new log group named 'MyGroup' and writes 'Hello, World!' to the output. .EXAMPLE + ```pwsh LogGroup 'MyGroup' { Write-Host 'Hello, World!' } + ``` Uses the alias 'LogGroup' to create a new log group named 'MyGroup' and writes 'Hello, World!' to the output. diff --git a/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 b/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 index 44282f5b0..ba99c94b1 100644 --- a/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 +++ b/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubNoCommandGroup { +function Set-GitHubNoCommandGroup { <# .SYNOPSIS Disables workflow commands for a block of code. @@ -8,18 +8,22 @@ Allows for colapsing of code in IDE for code that belong together. .EXAMPLE + ```pwsh Set-GitHubNoCommandGroup { Write-Host 'Hello, World!' Write-GithubError 'This is an error' } + ``` Groups commands where no workflow commands are run. .EXAMPLE + ```pwsh NoLogGroup 'MyGroup' { Write-Host 'Hello, World!' Write-GithubError 'This is an error' } + ``` Groups commands where no workflow commands are run, using an alias and DSL approach. diff --git a/src/functions/public/Commands/Set-GitHubOutput.ps1 b/src/functions/public/Commands/Set-GitHubOutput.ps1 index 228b415fe..7ddd57f65 100644 --- a/src/functions/public/Commands/Set-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Set-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubOutput { +function Set-GitHubOutput { <# .SYNOPSIS Sets the GitHub output for a given key and value. @@ -13,15 +13,19 @@ The Value parameter accepts null values, which will be correctly preserved and set as the output. .EXAMPLE + ```pwsh Set-GitHubOutput -Name 'ID' -Value '123123123' + ``` Sets the output variable 'ID' to '123123123' in the GitHub Actions output file. .EXAMPLE + ```pwsh Set-GitHubOutput -Name 'result' -Value @{ ID = '123123123' name = 'test' } + ``` .LINK https://psmodule.io/GitHub/Functions/Commands/Set-GitHubOutput diff --git a/src/functions/public/Commands/Set-GitHubStepSummary.ps1 b/src/functions/public/Commands/Set-GitHubStepSummary.ps1 index 597b79e30..8cbfcbc94 100644 --- a/src/functions/public/Commands/Set-GitHubStepSummary.ps1 +++ b/src/functions/public/Commands/Set-GitHubStepSummary.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubStepSummary { +function Set-GitHubStepSummary { <# .SYNOPSIS Set a summary for the step in GitHub Actions @@ -16,7 +16,9 @@ workflow run summary page. If multiple jobs generate summaries, the job summaries are ordered by job completion time. .EXAMPLE + ```pwsh Set-GitHubStepSummary -Summary 'Hello, World!' + ``` .NOTES [Adding a job summary](https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions?utm_source=chatgpt.com#adding-a-job-summary) diff --git a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 index 8c786b75b..4d81a5426 100644 --- a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 @@ -1,4 +1,4 @@ -function Start-GitHubLogGroup { +function Start-GitHubLogGroup { <# .SYNOPSIS Starts a log group in GitHub Actions @@ -15,20 +15,24 @@ .EXAMPLE ```pwsh + ```pwsh Start-GitHubLogGroup 'MyGroup' ``` + ``` Starts a new log group named 'MyGroup'. All subsequent log output will be grouped under this expandable section until Stop-GitHubLogGroup is called. .EXAMPLE ```pwsh + ```pwsh Start-GitHubLogGroup 'Building application' Write-Host 'Step 1: Restoring packages' Write-Host 'Step 2: Compiling code' Write-Host 'Step 3: Running tests' Stop-GitHubLogGroup ``` + ``` Creates a collapsible log group containing the build steps. The output will appear nested under the "Building application" header in the GitHub Actions log. diff --git a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 index b041b2336..acbc96019 100644 --- a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 @@ -1,4 +1,4 @@ -function Stop-GitHubLogGroup { +function Stop-GitHubLogGroup { <# .SYNOPSIS Stops the current log group in GitHub Actions @@ -14,19 +14,23 @@ .EXAMPLE ```pwsh + ```pwsh Stop-GitHubLogGroup ``` + ``` Stops the current log group in GitHub Actions. .EXAMPLE ```pwsh + ```pwsh Start-GitHubLogGroup 'Deployment Steps' Write-Host 'Deploying to staging...' Write-Host 'Deployment complete' Stop-GitHubLogGroup Write-Host 'This output is not in the group' ``` + ``` Creates a log group for deployment steps. The final Write-Host command outputs text outside of the group since Stop-GitHubLogGroup was called. diff --git a/src/functions/public/Commands/Write-GitHubDebug.ps1 b/src/functions/public/Commands/Write-GitHubDebug.ps1 index d6dfd3fc2..cebc540bf 100644 --- a/src/functions/public/Commands/Write-GitHubDebug.ps1 +++ b/src/functions/public/Commands/Write-GitHubDebug.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubDebug { +function Write-GitHubDebug { <# .SYNOPSIS Write a debug message in GitHub Actions @@ -11,7 +11,9 @@ If both the secret and variable are set, the value of the secret takes precedence over the variable. .EXAMPLE + ```pwsh Write-GitHubDebug -Message 'Hello, World!' + ``` Writes a debug message 'Hello, World!'. diff --git a/src/functions/public/Commands/Write-GitHubError.ps1 b/src/functions/public/Commands/Write-GitHubError.ps1 index 9b78d8889..473c6ae00 100644 --- a/src/functions/public/Commands/Write-GitHubError.ps1 +++ b/src/functions/public/Commands/Write-GitHubError.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubError { +function Write-GitHubError { <# .SYNOPSIS Write a error message in GitHub Actions @@ -7,7 +7,9 @@ Write a error message in GitHub Actions. The message will be displayed in the GitHub Actions log. .EXAMPLE + ```pwsh Write-GitHubError -Message 'Hello, World!' + ``` Writes a error message 'Hello, World!'. diff --git a/src/functions/public/Commands/Write-GitHubLog.ps1 b/src/functions/public/Commands/Write-GitHubLog.ps1 index 354f20a77..dfe9d84ca 100644 --- a/src/functions/public/Commands/Write-GitHubLog.ps1 +++ b/src/functions/public/Commands/Write-GitHubLog.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubLog { +function Write-GitHubLog { <# .SYNOPSIS Write a colored message in GitHub Actions or locally @@ -9,17 +9,23 @@ When not running in GitHub Actions, uses standard Write-Host. .EXAMPLE + ```pwsh Write-GitHubLog -Message 'Hello, World!' + ``` Writes 'Hello, World!' to the log. .EXAMPLE + ```pwsh Write-GitHubLog -Message 'Error occurred!' -ForegroundColor Red + ``` Writes 'Error occurred!' in red text. .EXAMPLE + ```pwsh Write-GitHubLog -Message 'Success!' -ForegroundColor Green -BackgroundColor Black + ``` Writes 'Success!' in green text on a black background. diff --git a/src/functions/public/Commands/Write-GitHubNotice.ps1 b/src/functions/public/Commands/Write-GitHubNotice.ps1 index 33c688917..1da3350f3 100644 --- a/src/functions/public/Commands/Write-GitHubNotice.ps1 +++ b/src/functions/public/Commands/Write-GitHubNotice.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubNotice { +function Write-GitHubNotice { <# .SYNOPSIS Write a notice message in GitHub Actions @@ -7,7 +7,9 @@ Write a notice message in GitHub Actions. The message will be displayed in the GitHub Actions log. .EXAMPLE + ```pwsh Write-GitHubNotice -Message 'Hello, World!' + ``` Writes a notice message 'Hello, World!'. diff --git a/src/functions/public/Commands/Write-GitHubWarning.ps1 b/src/functions/public/Commands/Write-GitHubWarning.ps1 index 59b7de045..39fca9bdd 100644 --- a/src/functions/public/Commands/Write-GitHubWarning.ps1 +++ b/src/functions/public/Commands/Write-GitHubWarning.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubWarning { +function Write-GitHubWarning { <# .SYNOPSIS Write a warning message in GitHub Actions @@ -7,7 +7,9 @@ Write a warning message in GitHub Actions. The message will be displayed in the GitHub Actions log. .EXAMPLE + ```pwsh Write-GitHubWarning -Message 'Hello, World!' + ``` Writes a warning message 'Hello, World!'. diff --git a/src/functions/public/Config/Get-GitHubConfig.ps1 b/src/functions/public/Config/Get-GitHubConfig.ps1 index 9471de437..ad6821e10 100644 --- a/src/functions/public/Config/Get-GitHubConfig.ps1 +++ b/src/functions/public/Config/Get-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubConfig { +function Get-GitHubConfig { <# .SYNOPSIS Get a GitHub module configuration. @@ -7,7 +7,9 @@ Get a GitHub module configuration. .EXAMPLE + ```pwsh Get-GitHubConfig -Name DefaultContext + ``` Get the DefaultContext value from the GitHub module configuration. diff --git a/src/functions/public/Config/Remove-GitHubConfig.ps1 b/src/functions/public/Config/Remove-GitHubConfig.ps1 index 8ae72d979..6d1bd3657 100644 --- a/src/functions/public/Config/Remove-GitHubConfig.ps1 +++ b/src/functions/public/Config/Remove-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubConfig { +function Remove-GitHubConfig { <# .SYNOPSIS Remove a GitHub module configuration. @@ -7,7 +7,9 @@ Remove a GitHub module configuration. .EXAMPLE + ```pwsh Remove-GitHubConfig -Name DefaultUser + ``` Removes the 'DefaultUser' item in the GitHub module configuration. diff --git a/src/functions/public/Config/Reset-GitHubConfig.ps1 b/src/functions/public/Config/Reset-GitHubConfig.ps1 index be3c7c951..a8e3ae8f9 100644 --- a/src/functions/public/Config/Reset-GitHubConfig.ps1 +++ b/src/functions/public/Config/Reset-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Reset-GitHubConfig { +function Reset-GitHubConfig { <# .SYNOPSIS Re-initializes the GitHub module configuration. @@ -7,7 +7,9 @@ Re-initializes the GitHub module configuration. .EXAMPLE + ```pwsh Reset-GitHubConfig + ``` Re-initializes the GitHub module configuration. diff --git a/src/functions/public/Config/Set-GitHubConfig.ps1 b/src/functions/public/Config/Set-GitHubConfig.ps1 index 648ab97a7..72d0a5546 100644 --- a/src/functions/public/Config/Set-GitHubConfig.ps1 +++ b/src/functions/public/Config/Set-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubConfig { +function Set-GitHubConfig { <# .SYNOPSIS Set a GitHub module configuration. @@ -7,7 +7,9 @@ Set a GitHub module configuration. .EXAMPLE + ```pwsh Set-GitHubConfig -Name DefaultUser -Value 'Octocat' + ``` Sets the value of DefaultUser to 'Octocat' in the GitHub module configuration. diff --git a/src/functions/public/Emojis/Get-GitHubEmoji.ps1 b/src/functions/public/Emojis/Get-GitHubEmoji.ps1 index ec00fba7e..4e9ce1689 100644 --- a/src/functions/public/Emojis/Get-GitHubEmoji.ps1 +++ b/src/functions/public/Emojis/Get-GitHubEmoji.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEmoji { +filter Get-GitHubEmoji { <# .SYNOPSIS Get emojis @@ -8,12 +8,16 @@ If you pass the `Path` parameter, the emojis will be downloaded to the specified destination. .EXAMPLE + ```pwsh Get-GitHubEmoji + ``` Gets all the emojis available to use on GitHub. .EXAMPLE + ```pwsh Get-GitHubEmoji -Path 'C:\Users\user\Documents\GitHub\Emojis' + ``` Downloads all the emojis available to use on GitHub to the specified destination. diff --git a/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 b/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 index 20493743e..df9902fcd 100644 --- a/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 +++ b/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterprise { +function Get-GitHubEnterprise { <# .SYNOPSIS Retrieves GitHub Enterprise instance details for the authenticated user. @@ -9,10 +9,12 @@ specific enterprise name is provided, details about that single instance are returned. .EXAMPLE + ```pwsh Get-GitHubEnterprise + ``` Output: - ```powershell + ```pwsh Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise @@ -27,10 +29,12 @@ Retrieves details about all GitHub Enterprise instances for the user. .EXAMPLE + ```pwsh Get-GitHubEnterprise -Name 'my-enterprise' + ``` Output: - ```powershell + ```pwsh Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise diff --git a/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 b/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 index 8de156d2c..be0890ff4 100644 --- a/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 +++ b/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterpriseOrganization { +function Get-GitHubEnterpriseOrganization { <# .SYNOPSIS Get the list of organizations in a GitHub Enterprise instance. @@ -7,7 +7,9 @@ Use this function to retrieve the list of organizations in a GitHub Enterprise instance. .EXAMPLE + ```pwsh Get-GitHubEnterpriseOrganization -Enterprise 'msx' + ``` .LINK https://psmodule.io/GitHub/Functions/Enterprise/Get-GitHubEnterpriseOrganization diff --git a/src/functions/public/Environments/Get-GitHubEnvironment.ps1 b/src/functions/public/Environments/Get-GitHubEnvironment.ps1 index 4c4979cfc..7073eb888 100644 --- a/src/functions/public/Environments/Get-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Get-GitHubEnvironment.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEnvironment { +filter Get-GitHubEnvironment { <# .SYNOPSIS Retrieves details of a specified GitHub environment or lists all environments for a repository. @@ -12,7 +12,9 @@ to use this function with a private repository. .EXAMPLE + ```pwsh Get-GitHubEnvironment -Owner 'PSModule' -Repository 'EnvironmentTest' -Name 'test' + ``` Output: ```pwsh @@ -33,7 +35,9 @@ Retrieves details of the "test" environment in the specified repository. .EXAMPLE + ```pwsh Get-GitHubEnvironment -Owner 'PSModule' -Repository 'EnvironmentTest' + ``` Output: ```pwsh diff --git a/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 b/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 index 393d988f1..23ffe5c3c 100644 --- a/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 @@ -8,7 +8,9 @@ filter Remove-GitHubEnvironment { The function supports ShouldProcess for confirmation before execution. .EXAMPLE + ```pwsh Remove-GitHubEnvironment -Owner 'PSModule' -Repository 'GitHub' -Name 'Production' + ``` Deletes the 'Production' environment from the 'PSModule/GitHub' repository. diff --git a/src/functions/public/Environments/Set-GitHubEnvironment.ps1 b/src/functions/public/Environments/Set-GitHubEnvironment.ps1 index fe8992859..b7f4f5e0b 100644 --- a/src/functions/public/Environments/Set-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Set-GitHubEnvironment.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubEnvironment { +filter Set-GitHubEnvironment { <# .SYNOPSIS Create or update an environment. @@ -15,6 +15,7 @@ OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh $params = @{ Owner = "my-org" Repository = "my-repo" @@ -24,9 +25,10 @@ DeploymentBranchPolicy = 'CustomBranchPolicies' } Set-GitHubEnvironment @params + ``` Output: - ```powershell + ```pwsh id : 5944178128 node_id : EN_kwDOOJqfM88AAAABYkz10A name : test diff --git a/src/functions/public/Git/Get-GitHubGitConfig.ps1 b/src/functions/public/Git/Get-GitHubGitConfig.ps1 index 06dc8834f..69c325776 100644 --- a/src/functions/public/Git/Get-GitHubGitConfig.ps1 +++ b/src/functions/public/Git/Get-GitHubGitConfig.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubGitConfig { +function Get-GitHubGitConfig { <# .SYNOPSIS Gets the global Git configuration. @@ -7,7 +7,9 @@ Gets the global Git configuration. .EXAMPLE + ```pwsh Get-GitHubGitConfig + ``` Gets the global Git configuration. diff --git a/src/functions/public/Git/Set-GitHubGitConfig.ps1 b/src/functions/public/Git/Set-GitHubGitConfig.ps1 index 60de58c7d..6e59f281d 100644 --- a/src/functions/public/Git/Set-GitHubGitConfig.ps1 +++ b/src/functions/public/Git/Set-GitHubGitConfig.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubGitConfig { +function Set-GitHubGitConfig { <# .SYNOPSIS Set the Git configuration for the GitHub context. @@ -7,12 +7,16 @@ Sets the Git configuration for the GitHub context. This command sets the `user.name`, `user.email`, and `url..insteadOf` git configs. .EXAMPLE + ```pwsh Set-GitHubGitConfig + ``` Sets the Git configuration for the default GitHub context. .EXAMPLE + ```pwsh Set-GitHubGitConfig -Context 'MyContext' + ``` Sets the Git configuration for the GitHub context named 'MyContext'. diff --git a/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 b/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 index 4340a81ed..3dc2ea181 100644 --- a/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 +++ b/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubGitignore { +filter Get-GitHubGitignore { <# .SYNOPSIS Get a gitignore template or list of all gitignore templates names @@ -8,12 +8,16 @@ If the Name parameter is specified, the function will return the gitignore template for the specified name. .EXAMPLE + ```pwsh Get-GitHubGitignoreList + ``` Get all gitignore templates .EXAMPLE + ```pwsh Get-GitHubGitignore -Name 'VisualStudio' + ``` Get a gitignore template for VisualStudio diff --git a/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 b/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 index cea4e1429..323941875 100644 --- a/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 +++ b/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 @@ -1,4 +1,4 @@ -function ConvertFrom-IssueForm { +function ConvertFrom-IssueForm { <# .SYNOPSIS Converts the issue form content into a hashtable or object. @@ -8,10 +8,12 @@ Section titles become keys and their content becomes values. .EXAMPLE + ```pwsh @' ### Section 1 Content 1 Content 2 + ``` ### Section 2 - [ ] Item 1 diff --git a/src/functions/public/License/Get-GitHubLicense.ps1 b/src/functions/public/License/Get-GitHubLicense.ps1 index d0fe9b632..7a218d9dd 100644 --- a/src/functions/public/License/Get-GitHubLicense.ps1 +++ b/src/functions/public/License/Get-GitHubLicense.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubLicense { +filter Get-GitHubLicense { <# .SYNOPSIS Get a license template, list of all popular license templates or a license for a repository @@ -9,17 +9,23 @@ If the Owner and Repo parameters are specified, the function will return the license for the specified repository. .EXAMPLE + ```pwsh Get-GitHubLicense + ``` Get all license templates .EXAMPLE + ```pwsh Get-GitHubLicense -Name mit + ``` Get the mit license template .EXAMPLE + ```pwsh Get-GitHubLicense -Owner 'octocat' -Repository 'Hello-World' + ``` Get the license for the Hello-World repository from the octocat account. diff --git a/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 b/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 index e04d5f538..37fdaa2e4 100644 --- a/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 +++ b/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMarkdown { +filter Get-GitHubMarkdown { <# .SYNOPSIS Render a Markdown document @@ -7,8 +7,10 @@ Converts Markdown to HTML .EXAMPLE + ```pwsh Get-GitHubMarkdown -Text "Hello **world**" "

Hello world

" + ``` Renders the Markdown text "Hello **world**" to HTML. diff --git a/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 b/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 index 212815387..1c8699deb 100644 --- a/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 +++ b/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMarkdownRaw { +filter Get-GitHubMarkdownRaw { <# .SYNOPSIS Render a Markdown document in raw mode @@ -9,8 +9,10 @@ format like a README.md file. Markdown content must be 400 KB or less. .EXAMPLE + ```pwsh Get-GitHubMarkdownRaw -Text 'Hello, world!' "

Hello world

" + ``` Render the Markdown text 'Hello, world!' in raw mode. diff --git a/src/functions/public/Meta/Get-GitHubApiVersion.ps1 b/src/functions/public/Meta/Get-GitHubApiVersion.ps1 index cd9ac2b0a..f48864977 100644 --- a/src/functions/public/Meta/Get-GitHubApiVersion.ps1 +++ b/src/functions/public/Meta/Get-GitHubApiVersion.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubApiVersion { +filter Get-GitHubApiVersion { <# .SYNOPSIS Get all API versions. @@ -7,7 +7,9 @@ Get all supported GitHub API versions. .EXAMPLE + ```pwsh Get-GitHubApiVersion + ``` Get all supported GitHub API versions. diff --git a/src/functions/public/Meta/Get-GitHubMeta.ps1 b/src/functions/public/Meta/Get-GitHubMeta.ps1 index 156523d2f..ee27c1bc9 100644 --- a/src/functions/public/Meta/Get-GitHubMeta.ps1 +++ b/src/functions/public/Meta/Get-GitHubMeta.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMeta { +filter Get-GitHubMeta { <# .SYNOPSIS Get GitHub meta information. @@ -15,7 +15,9 @@ documentation for each feature to determine if IPv6 is supported. .EXAMPLE + ```pwsh Get-GitHubMeta + ``` Returns meta information about GitHub, including a list of GitHub's IP addresses. diff --git a/src/functions/public/Meta/Get-GitHubOctocat.ps1 b/src/functions/public/Meta/Get-GitHubOctocat.ps1 index ae2c8d438..0799b7b12 100644 --- a/src/functions/public/Meta/Get-GitHubOctocat.ps1 +++ b/src/functions/public/Meta/Get-GitHubOctocat.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubOctocat { +filter Get-GitHubOctocat { <# .SYNOPSIS Get Octocat. @@ -7,12 +7,16 @@ Get the octocat as ASCII art. .EXAMPLE + ```pwsh Get-GitHubOctocat + ``` Get the octocat as ASCII art .EXAMPLE + ```pwsh Get-GitHubOctocat -S "Hello world" + ``` Get the octocat as ASCII art with a custom saying diff --git a/src/functions/public/Meta/Get-GitHubRoot.ps1 b/src/functions/public/Meta/Get-GitHubRoot.ps1 index 196782dcf..cb77e36d5 100644 --- a/src/functions/public/Meta/Get-GitHubRoot.ps1 +++ b/src/functions/public/Meta/Get-GitHubRoot.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRoot { +filter Get-GitHubRoot { <# .SYNOPSIS GitHub API Root. @@ -7,7 +7,9 @@ Get Hypermedia links to resources accessible in GitHub's REST API. .EXAMPLE + ```pwsh Get-GitHubRoot + ``` Get the root endpoint for the GitHub API. diff --git a/src/functions/public/Meta/Get-GitHubZen.ps1 b/src/functions/public/Meta/Get-GitHubZen.ps1 index 7f2fbb7cc..2b0c593a4 100644 --- a/src/functions/public/Meta/Get-GitHubZen.ps1 +++ b/src/functions/public/Meta/Get-GitHubZen.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubZen { +filter Get-GitHubZen { <# .SYNOPSIS Get the Zen of GitHub. @@ -7,7 +7,9 @@ Get a random sentence from the Zen of GitHub. .EXAMPLE + ```pwsh Get-GitHubZen + ``` Get a random sentence from the Zen of GitHub. diff --git a/src/functions/public/Organization/Get-GitHubOrganization.ps1 b/src/functions/public/Organization/Get-GitHubOrganization.ps1 index 526e66e74..67cefdcef 100644 --- a/src/functions/public/Organization/Get-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Get-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubOrganization { +filter Get-GitHubOrganization { <# .SYNOPSIS List organization @@ -10,27 +10,37 @@ Get an organization - if a organization name is provided. .EXAMPLE + ```pwsh Get-GitHubOrganization + ``` List all organizations for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubOrganization -Username 'octocat' + ``` List public organizations for a specific user. .EXAMPLE + ```pwsh Get-GitHubOrganization -All -Since 142951047 + ``` List all organizations made after an ID. .EXAMPLE + ```pwsh Get-GitHubOrganization -Name 'PSModule' + ``` Get a specific organization. .EXAMPLE + ```pwsh Get-GitHubOrganization -Enterprise 'msx' + ``` Get the organizations belonging to an Enterprise. diff --git a/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 b/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 index 3476a62c3..1bae1d367 100644 --- a/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 +++ b/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubOrganizationPendingInvitation { +function Get-GitHubOrganizationPendingInvitation { <# .SYNOPSIS List pending organization invitations @@ -10,12 +10,16 @@ member, the `login` field in the return hash will be `null`. .EXAMPLE + ```pwsh Get-GitHubOrganizationPendingInvitation -Organization 'github' + ``` List all pending organization invitations for the organization `github`. .EXAMPLE + ```pwsh Get-GitHubOrganizationPendingInvitation -Organization 'github' -Role 'admin' + ``` List all pending organization invitations for the organization `github` with the role `admin`. diff --git a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 index 6094fd6ac..c21fb3c65 100644 --- a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 @@ -1,4 +1,4 @@ -function New-GitHubOrganizationInvitation { +function New-GitHubOrganizationInvitation { <# .SYNOPSIS Create an organization invitation @@ -14,15 +14,19 @@ .EXAMPLE ```pwsh + ```pwsh New-GitHubOrganizationInvitation -Organization 'PSModule' -InviteeID 123456789 -Role 'admin' ``` + ``` Invites the user with the ID `12345679` to the organization `PSModule` with the role `admin`. .EXAMPLE ```pwsh + ```pwsh New-GitHubOrganizationInvitation -Organization 'PSModule' -Email 'user@psmodule.io' ``` + ``` Invites the user with the email `user@psmodule.io` to the organization `PSModule`. diff --git a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 index 5751c243d..6faadef17 100644 --- a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubOrganizationInvitation { +function Remove-GitHubOrganizationInvitation { <# .SYNOPSIS Cancel an organization invitation @@ -10,8 +10,10 @@ .EXAMPLE ```pwsh + ```pwsh Remove-GitHubOrganizationInvitation -Organization 'github' -InvitationID '12345678' ``` + ``` Cancel the invitation with the ID '12345678' for the organization `github`. diff --git a/src/functions/public/Organization/New-GitHubOrganization.ps1 b/src/functions/public/Organization/New-GitHubOrganization.ps1 index d8412b060..9380e9c0c 100644 --- a/src/functions/public/Organization/New-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/New-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -function New-GitHubOrganization { +function New-GitHubOrganization { <# .SYNOPSIS Creates a new GitHub organization within a specified enterprise. @@ -8,8 +8,10 @@ .EXAMPLE ```pwsh + ```pwsh New-GitHubOrganization -Enterprise 'my-enterprise' -Name 'my-org' -Owner 'user1' -BillingEmail 'billing@example.com' ``` + ``` .OUTPUTS GitHubOrganization diff --git a/src/functions/public/Organization/Remove-GitHubOrganization.ps1 b/src/functions/public/Organization/Remove-GitHubOrganization.ps1 index 8f31b57c3..371f6f738 100644 --- a/src/functions/public/Organization/Remove-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Remove-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubOrganization { +filter Remove-GitHubOrganization { <# .SYNOPSIS Delete an organization @@ -10,7 +10,9 @@ regarding account deletion before using this endpoint. .EXAMPLE + ```pwsh Remove-GitHubOrganization -Name 'GitHub' + ``` Deletes the organization 'GitHub' and all its repositories. diff --git a/src/functions/public/Organization/Update-GitHubOrganization.ps1 b/src/functions/public/Organization/Update-GitHubOrganization.ps1 index 2315d6c90..25ecd1dff 100644 --- a/src/functions/public/Organization/Update-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Update-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubOrganization { +filter Update-GitHubOrganization { <# .SYNOPSIS Update an organization @@ -8,11 +8,14 @@ profile and member privileges. .EXAMPLE + ```pwsh Update-GitHubOrganization -Organization 'GitHub' -Description 'The official GitHub organization.' + ``` Sets the description for the organization 'GitHub' to 'The official GitHub organization.'. .EXAMPLE + ```pwsh $param = @{ Organization = 'GitHub' MembersCanCreatePublicRepositories = $true @@ -20,6 +23,7 @@ MembersCanCreateInternalRepositories = $true } Update-GitHubOrganization @param + ``` Sets the repository creation permissions for the organization 'GitHub' to allow all members to create public, private, and internal repositories. diff --git a/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 b/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 index c7a6830c0..ed5932d1a 100644 --- a/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 +++ b/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRateLimit { +filter Get-GitHubRateLimit { <# .SYNOPSIS Get rate limit status for the authenticated user @@ -22,7 +22,9 @@ instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. .EXAMPLE + ```pwsh Get-GitHubRateLimit + ``` Gets the rate limit status for the authenticated user. diff --git a/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 index 5e9832840..8bb0ced71 100644 --- a/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubReleaseAsset { +filter Add-GitHubReleaseAsset { <# .SYNOPSIS Upload a release asset @@ -37,12 +37,16 @@ the old file before you can re-upload the new asset. .EXAMPLE + ```pwsh Add-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '7654321' -Path 'C:\Users\octocat\Downloads\hello-world.zip' + ``` Gets the release assets for the release with the ID '1234567' for the repository 'octocat/hello-world'. .EXAMPLE + ```pwsh Add-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '7654321' -Path 'C:\Users\octocat\Projects\MyApp' + ``` Automatically creates a ZIP file from the contents of the MyApp directory and uploads it as a release asset. diff --git a/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 index 5042c6582..77ad658a9 100644 --- a/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAsset { +filter Get-GitHubReleaseAsset { <# .SYNOPSIS List release assets based on a release ID, asset ID, or asset name @@ -10,22 +10,30 @@ If a tag and name are provided, the specific named asset from the release with that tag is returned. .EXAMPLE + ```pwsh Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '1234567' + ``` Gets the release asset with the ID '1234567' for the repository 'octocat/hello-world'. .EXAMPLE + ```pwsh Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ReleaseID '7654321' + ``` Gets all release assets for the release with the ID '7654321' for the repository 'octocat/hello-world'. .EXAMPLE + ```pwsh Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ReleaseID '7654321' -Name 'example.zip' + ``` Gets the release asset named 'example.zip' from the release with ID '7654321' for the repository 'octocat/hello-world'. .EXAMPLE + ```pwsh Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Name 'example.zip' + ``` Gets the release asset named 'example.zip' from the release tagged as 'v1.0.0' for the repository 'octocat/hello-world'. diff --git a/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 index 76efada9c..6ca88ca80 100644 --- a/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 @@ -7,7 +7,9 @@ filter Remove-GitHubReleaseAsset { Delete a release asset .EXAMPLE + ```pwsh Remove-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '1234567' + ``` Deletes the release asset with the ID '1234567' for the repository 'octocat/hello-world'. diff --git a/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 index 575c8b7c3..6173a964e 100644 --- a/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -function Save-GitHubReleaseAsset { +function Save-GitHubReleaseAsset { <# .SYNOPSIS Downloads a GitHub Release asset. @@ -9,10 +9,12 @@ personal access tokens (classic) or OAuth tokens with the `repo` scope are required. .EXAMPLE + ```pwsh Save-GitHubReleaseAsset -Owner 'octocat' -Repository 'Hello-World' -ID '123456' -Path 'C:\Assets' + ``` Output: - ```powershell + ```pwsh Directory: C:\Assets Mode LastWriteTime Length Name @@ -23,10 +25,12 @@ Downloads release asset ID '123456' from the 'Hello-World' repository owned by 'octocat' to the specified path. .EXAMPLE + ```pwsh Save-GitHubReleaseAsset -Owner 'octocat' -Repository 'Hello-World' -Tag 'v1.0.0' -Name 'binary.zip' -Path 'C:\Assets\app' -Expand -Force + ``` Output: - ```powershell + ```pwsh Directory: C:\Assets\app Mode LastWriteTime Length Name @@ -39,6 +43,7 @@ to the specified path, overwriting existing files during download and extraction. .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repository = 'Hello-World' @@ -47,6 +52,7 @@ Name = 'binary.zip' } Get-GitHubReleaseAsset @params | Save-GitHubReleaseAsset -Path 'C:\Assets' -Expand -Force + ``` Pipes a release asset object directly to the Save-GitHubReleaseAsset function, which downloads and extracts it. diff --git a/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 index ac95ac0d5..8413b0bf2 100644 --- a/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubReleaseAsset { +filter Update-GitHubReleaseAsset { <# .SYNOPSIS Update a release asset @@ -7,7 +7,9 @@ Users with push access to the repository can edit a release asset. .EXAMPLE + ```pwsh Update-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '1234567' -Name 'new_asset_name' -Label 'new_asset_label' + ``` Updates the release asset with the ID '1234567' for the repository 'octocat/hello-world' with the new name 'new_asset_name' and label 'new_asset_label'. diff --git a/src/functions/public/Releases/Get-GitHubRelease.ps1 b/src/functions/public/Releases/Get-GitHubRelease.ps1 index e4bd3081c..c70ca3045 100644 --- a/src/functions/public/Releases/Get-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Get-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRelease { +filter Get-GitHubRelease { <# .SYNOPSIS Retrieves GitHub release information for a repository. @@ -9,22 +9,30 @@ Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. .EXAMPLE + ```pwsh Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' + ``` Gets the latest release for the repository 'hello-world' owned by 'octocat'. .EXAMPLE + ```pwsh Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -AllVersions + ``` Gets all releases for the repository 'hello-world' owned by 'octocat'. .EXAMPLE + ```pwsh Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' + ``` Gets the release with the tag 'v1.0.0' for the repository 'hello-world' owned by 'octocat'. .EXAMPLE + ```pwsh Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -ID '1234567' + ``` Gets the release with the ID '1234567' for the repository 'hello-world' owned by 'octocat'. diff --git a/src/functions/public/Releases/New-GitHubRelease.ps1 b/src/functions/public/Releases/New-GitHubRelease.ps1 index 67aa10cf7..8e37e43ec 100644 --- a/src/functions/public/Releases/New-GitHubRelease.ps1 +++ b/src/functions/public/Releases/New-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRelease { +filter New-GitHubRelease { <# .SYNOPSIS Create a release @@ -11,28 +11,38 @@ and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. .EXAMPLE + ```pwsh New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Target 'main' -Notes 'Release notes' + ``` Creates a release for the repository 'octocat/hello-world' on the 'main' branch with the tag 'v1.0.0'. .EXAMPLE + ```pwsh New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v0.9.0' -Name 'Beta Release' -Draft -Prerelease + ``` Creates a draft prerelease for the repository 'octocat/hello-world' with the tag 'v0.9.0' using the default target branch ('main'). .EXAMPLE + ```pwsh New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v2.0.0' -Latest + ``` Creates a release for the repository 'octocat/hello-world' with the tag 'v2.0.0' and marks it as the latest release. Note that when using -Latest, you cannot use -Draft or -Prerelease as they are mutually exclusive. .EXAMPLE + ```pwsh New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.1.0' -GenerateReleaseNotes + ``` Creates a release for the repository 'octocat/hello-world' with the tag 'v1.1.0' and automatically generates release notes based on commits since the previous release. .EXAMPLE + ```pwsh New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.2.0' -DiscussionCategoryName 'Announcements' -Notes 'Major update with new features' + ``` Creates a release for the repository 'octocat/hello-world' with the tag 'v1.2.0' and creates a discussion in the 'Announcements' category linked to this release. diff --git a/src/functions/public/Releases/New-GitHubReleaseNote.ps1 b/src/functions/public/Releases/New-GitHubReleaseNote.ps1 index a81e18130..b139bb467 100644 --- a/src/functions/public/Releases/New-GitHubReleaseNote.ps1 +++ b/src/functions/public/Releases/New-GitHubReleaseNote.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubReleaseNote { +filter New-GitHubReleaseNote { <# .SYNOPSIS Generate release notes content for a release. @@ -9,18 +9,21 @@ The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repository = 'hello-world' Tag = 'v1.0.0' } New-GitHubReleaseNote @params + ``` Creates a new release notes draft for the repository 'hello-world' owned by 'octocat' with the tag name 'v1.0.0'. In this example the tag 'v1.0.0' has to exist in the repository. The configuration file '.github/release.yml' or '.github/release.yaml' will be used. .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repository = 'hello-world' @@ -28,11 +31,13 @@ Target = 'main' } New-GitHubReleaseNote @params + ``` Creates a new release notes draft for the repository 'hello-world' owned by 'octocat' with the tag name 'v1.0.0'. In this example the tag 'v1.0.0' has to exist in the repository. .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repository = 'hello-world' @@ -42,6 +47,7 @@ ConfigurationFilePath = '.github/custom_release_config.yml' } New-GitHubReleaseNote @params + ``` Creates a new release notes draft for the repository 'hello-world' owned by 'octocat' with the tag name 'v1.0.0'. The release notes will be based on the changes between the tags 'v0.9.2' and 'v1.0.0' and generated based on the diff --git a/src/functions/public/Releases/Remove-GitHubRelease.ps1 b/src/functions/public/Releases/Remove-GitHubRelease.ps1 index 6bddf1cb0..e489ddbfe 100644 --- a/src/functions/public/Releases/Remove-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Remove-GitHubRelease.ps1 @@ -7,7 +7,9 @@ filter Remove-GitHubRelease { Users with push access to the repository can delete a release. .EXAMPLE + ```pwsh Remove-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -ID '1234567' + ``` Deletes the release with the ID '1234567' for the repository 'octocat/hello-world'. diff --git a/src/functions/public/Releases/Set-GitHubRelease.ps1 b/src/functions/public/Releases/Set-GitHubRelease.ps1 index 41f0e483e..e7278cdc1 100644 --- a/src/functions/public/Releases/Set-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Set-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubRelease { +filter Set-GitHubRelease { <# .SYNOPSIS Creates or updates a release. @@ -16,38 +16,52 @@ When using the 'Latest' parameter, the release will be promoted from draft/prerelease status to a full release. .EXAMPLE + ```pwsh Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Target 'main' -Notes 'Release notes' + ``` Creates a new release with tag 'v1.0.0' targeting the 'main' branch. .EXAMPLE + ```pwsh Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Notes 'Updated release notes' + ``` Updates an existing release with tag 'v1.0.0' to have new release notes. .EXAMPLE + ```pwsh Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Draft + ``` Creates or updates a release as a draft release. .EXAMPLE + ```pwsh Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Prerelease + ``` Creates or updates a release as a prerelease. .EXAMPLE + ```pwsh Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Latest + ``` Sets the release with tag 'v1.0.0' as the latest release for the repository. If the release was a draft or prerelease, it will be promoted to a full release. .EXAMPLE + ```pwsh Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -GenerateReleaseNotes + ``` Creates or updates a release with automatically generated release notes based on pull requests and commits. .EXAMPLE + ```pwsh Get-GitHubRepository -Owner 'octocat' -Repository 'hello-world' | Set-GitHubRelease -Tag 'v1.0.0' -Notes 'Release notes' + ``` Creates or updates a release using pipeline input for the repository. diff --git a/src/functions/public/Releases/Update-GitHubRelease.ps1 b/src/functions/public/Releases/Update-GitHubRelease.ps1 index 92d27100c..c9d65d415 100644 --- a/src/functions/public/Releases/Update-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Update-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubRelease { +filter Update-GitHubRelease { <# .SYNOPSIS Update a release @@ -10,23 +10,31 @@ The function also accepts GitHubRelease objects through the pipeline. .EXAMPLE + ```pwsh Update-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -ID '1234567' -Notes 'Release notes' + ``` Updates the release with the ID '1234567' for the repository 'octocat/hello-world' with the note 'Release notes'. .EXAMPLE + ```pwsh Update-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0' -Name 'Release v1.0' -Notes 'Stable release' + ``` Updates the release with the tag 'v1.0' for the repository 'octocat/hello-world' with a new name and notes. .EXAMPLE + ```pwsh Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0' | Update-GitHubRelease -Draft:$false -Prerelease + ``` Gets a release by tag and updates it to be a prerelease (not a draft). .EXAMPLE + ```pwsh Update-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0' -Latest -GenerateReleaseNotes + ``` Updates the release with tag 'v1.0' to be the latest release and automatically generates release notes. diff --git a/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 index 21aaed536..93c4367de 100644 --- a/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryAutolink { +filter Get-GitHubRepositoryAutolink { <# .SYNOPSIS List all autolinks of a repository @@ -9,12 +9,16 @@ Information about autolinks are only available to repository administrators. .EXAMPLE + ```pwsh Get-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' + ``` Gets all autolinks for the repository 'Hello-World' owned by 'octocat'. .EXAMPLE + ```pwsh Get-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' -ID 1 + ``` Gets the autolink with the ID 1 for the repository 'Hello-World' owned by 'octocat'. diff --git a/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 index bdfc0ce06..fdf6f8ea6 100644 --- a/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryAutolink { +filter New-GitHubRepositoryAutolink { <# .SYNOPSIS Create an autolink reference for a repository @@ -7,7 +7,9 @@ Users with admin access to the repository can create an autolink. .EXAMPLE + ```pwsh New-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' -KeyPrefix 'GH-' -UrlTemplate 'https://www.example.com/issue/' + ``` Creates an autolink for the repository 'Hello-World' owned by 'octocat' that links to when the prefix 'GH-' is found in an issue, pull request, or commit. diff --git a/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 index 1e1b9b2cb..3121212a8 100644 --- a/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubRepositoryAutolink { +filter Remove-GitHubRepositoryAutolink { <# .SYNOPSIS Delete an autolink reference from a repository @@ -9,7 +9,9 @@ Information about autolinks are only available to repository administrators. .EXAMPLE + ```pwsh Remove-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' -AutolinkId 1 + ``` Deletes the autolink with ID 1 for the repository 'Hello-World' owned by 'octocat'. diff --git a/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 b/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 index f82e932f7..a74118485 100644 --- a/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 +++ b/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryCustomProperty { +filter Get-GitHubRepositoryCustomProperty { <# .SYNOPSIS Get all custom property values for a repository @@ -8,7 +8,9 @@ Users with read access to the repository can use this endpoint. .EXAMPLE + ```pwsh Get-GitHubRepositoryCustomProperty -Owner 'octocat' -Repository 'hello-world' + ``` Gets all custom property values that are set for the 'hello-world' repository. diff --git a/src/functions/public/Repositories/Get-GitHubRepository.ps1 b/src/functions/public/Repositories/Get-GitHubRepository.ps1 index ea1d37fed..43545dc6b 100644 --- a/src/functions/public/Repositories/Get-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Get-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepository { +filter Get-GitHubRepository { <# .SYNOPSIS Gets a specific repository or list of repositories. @@ -11,27 +11,37 @@ Can also be used with the name parameter to get a specific repository. .EXAMPLE + ```pwsh Get-GitHubRepository + ``` Gets the repositories for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubRepository -Username 'octocat' + ``` Gets the repositories for the specified user. .EXAMPLE + ```pwsh Get-GitHubRepository -Organization 'github' -Name 'octocat' + ``` Gets the specified repository. .EXAMPLE + ```pwsh Get-GitHubRepository -Organization 'github' -Team 'my-team' + ``` Gets repositories that the 'my-team' team has access to in the `github` organization. .EXAMPLE + ```pwsh Get-GitHubRepository -Organization 'github' -Name 'octocat' -Team 'my-team' + ``` Gets the repository and permission for the `my-team` team on the `octocat` repository in the `github` organization. diff --git a/src/functions/public/Repositories/Move-GitHubRepository.ps1 b/src/functions/public/Repositories/Move-GitHubRepository.ps1 index 204d24318..09d0255ff 100644 --- a/src/functions/public/Repositories/Move-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Move-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Move-GitHubRepository { +filter Move-GitHubRepository { <# .SYNOPSIS Transfer a repository @@ -12,7 +12,9 @@ a fine-grained personal access token cannot be used because they are only granted access to a single account. .EXAMPLE + ```pwsh Move-GitHubRepository -Owner 'PSModule' -Name 'GitHub' -NewOwner 'GitHub' -NewName 'PowerShell' + ``` Moves the GitHub repository to the PSModule organization and renames it to GitHub. diff --git a/src/functions/public/Repositories/New-GitHubRepository.ps1 b/src/functions/public/Repositories/New-GitHubRepository.ps1 index cc0a0d7dd..afd35acff 100644 --- a/src/functions/public/Repositories/New-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/New-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepository { +filter New-GitHubRepository { <# .SYNOPSIS Create a repository for a user or an organization. @@ -14,6 +14,7 @@ * `repo` scope to create a private repository .EXAMPLE + ```pwsh $params = @{ Name = 'Hello-World' Description = 'This is your first repository' @@ -31,10 +32,12 @@ SquashMergeCommitMessage = 'PR_BODY' } New-GitHubRepository @params + ``` Creates a new public repository named "Hello-World" owned by the authenticated user. .EXAMPLE + ```pwsh $params = @{ Organization = 'PSModule' Name = 'Hello-World' @@ -52,10 +55,12 @@ SquashMergeCommitMessage = 'PR_BODY' } New-GitHubRepository @params + ``` Creates a new public repository named "Hello-World" owned by the organization "PSModule". .EXAMPLE + ```pwsh $params = @{ TemplateOwner = 'GitHub' TemplateRepository = 'octocat' @@ -66,10 +71,12 @@ Visibility = 'Private' } New-GitHubRepository @params + ``` Creates a new private repository named `MyNewRepo` from the `octocat` template repository owned by `GitHub`. .EXAMPLE + ```pwsh $params = @{ ForkOwner = 'octocat' ForkRepo = 'Hello-World' @@ -78,6 +85,7 @@ DefaultBranchOnly = $true } New-GitHubRepository @params + ``` Creates a new repository named `MyNewRepo` as a fork of `Hello-World` owned by `octocat`. Only the default branch will be forked. diff --git a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 index e8fee6918..f6aee0858 100644 --- a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryPermission { +filter Get-GitHubRepositoryPermission { <# .SYNOPSIS Get the permission level for a team on a repository. @@ -7,16 +7,20 @@ Retrieves the permission level assigned to a specific team for a given GitHub repository. .EXAMPLE + ```pwsh Get-GitHubRepositoryPermission -Owner 'octocat' -Name 'Hello-World' -Team 'core' + ``` Output: - ```powershell + ```pwsh Admin ``` Retrieves the permission of the 'core' team on the 'Hello-World' repository owned by 'octocat'. .EXAMPLE + ```pwsh + ``` .INPUTS diff --git a/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 index ba25d66e8..236a2c2ba 100644 --- a/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubRepositoryPermission { +filter Remove-GitHubRepositoryPermission { <# .SYNOPSIS Remove the permission level for a team on a repository. @@ -7,7 +7,9 @@ This function removes a team's access to a specific repository within an organization. .EXAMPLE + ```pwsh Remove-GitHubRepositoryPermission -Owner 'my-org' -Name 'repo-name' -Team 'dev-team' + ``` Removes the 'dev-team' permissions from the 'repo-name' repository under 'my-org'. diff --git a/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 index a2ab0cbe6..4741459d0 100644 --- a/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubRepositoryPermission { +filter Set-GitHubRepositoryPermission { <# .SYNOPSIS Set the permission level for a team on a repository @@ -9,7 +9,9 @@ 'None' is specified, the function removes the team's access to the repository. .EXAMPLE + ```pwsh Set-GitHubRepositoryPermission -Owner 'MyOrg' -Name 'MyRepo' -Team 'devs' -Permission 'push' + ``` Grants the 'push' permission to the 'devs' team for the repository 'MyRepo' owned by 'MyOrg'. diff --git a/src/functions/public/Repositories/Remove-GitHubRepository.ps1 b/src/functions/public/Repositories/Remove-GitHubRepository.ps1 index c96546fb3..3a085cde0 100644 --- a/src/functions/public/Repositories/Remove-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Remove-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubRepository { +filter Remove-GitHubRepository { <# .SYNOPSIS Delete a repository @@ -10,7 +10,9 @@ repositories, you will get a `403 Forbidden` response. .EXAMPLE + ```pwsh Remove-GitHubRepository -Owner 'PSModule' -Name 'Hello-World' + ``` Deletes the repository `Hello-World` in the `PSModule` organization. diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 index fcaccf936..b2c5b7012 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubRepositoryPrivateVulnerabilityReporting { +filter Disable-GitHubRepositoryPrivateVulnerabilityReporting { <# .SYNOPSIS Disable private vulnerability reporting for a repository @@ -9,7 +9,9 @@ "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". .EXAMPLE + ```pwsh Disable-GitHubRepositoryPrivateVulnerabilityReporting -Owner 'PSModule' -Name 'GitHub' + ``` Disables private vulnerability reporting for the PSModule/GitHub repository. diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 index 452365d86..a35a3cbc5 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubRepositorySecurityFix { +filter Disable-GitHubRepositorySecurityFix { <# .SYNOPSIS Disable automated security fixes @@ -9,7 +9,9 @@ "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". .EXAMPLE + ```pwsh Disable-GitHubRepositorySecurityFix -Owner 'PSModule' -Name 'GitHub' + ``` Disables automated security fixes for the repository. diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 index 3b43161d5..0f2be001b 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubRepositoryVulnerabilityAlert { +filter Disable-GitHubRepositoryVulnerabilityAlert { <# .SYNOPSIS Disable vulnerability alerts @@ -9,7 +9,9 @@ "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". .EXAMPLE + ```pwsh Disable-GitHubRepositoryVulnerabilityAlert -Owner 'octocat' -Name 'hello-world' + ``` Disables vulnerability alerts for the 'octocat/hello-world' repository. diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 index d6bebba62..68a6cb9dc 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubRepositoryPrivateVulnerabilityReporting { +filter Enable-GitHubRepositoryPrivateVulnerabilityReporting { <# .SYNOPSIS Enable private vulnerability reporting for a repository @@ -9,7 +9,9 @@ "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." .EXAMPLE + ```pwsh Enable-GitHubRepositoryPrivateVulnerabilityReporting -Owner 'PSModule' -Name 'GitHub' + ``` Enables private vulnerability reporting for the PSModule/GitHub repository. diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 index 67fa2f94f..860d70490 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubRepositorySecurityFix { +filter Enable-GitHubRepositorySecurityFix { <# .SYNOPSIS Enable automated security fixes @@ -9,7 +9,9 @@ "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". .EXAMPLE + ```pwsh Enable-GitHubRepositorySecurityFix -Owner 'PSModule' -Name 'GitHub' + ``` Enables automated security fixes for the repository. diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 index 584ed3668..7e968ddcf 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubRepositoryVulnerabilityAlert { +filter Enable-GitHubRepositoryVulnerabilityAlert { <# .SYNOPSIS Enable vulnerability alerts @@ -10,7 +10,9 @@ "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". .EXAMPLE + ```pwsh Enable-GitHubRepositoryVulnerabilityAlert -Owner 'octocat' -Name 'hello-world' + ``` Enables vulnerability alerts for the 'octocat/hello-world' repository. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 index e73fcf83d..30aeebd97 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryActivity { +filter Get-GitHubRepositoryActivity { <# .SYNOPSIS List repository activities @@ -11,27 +11,42 @@ see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' + ``` .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Direction 'asc' + ``` .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -PerPage 100 + ``` .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Before '2021-01-01T00:00:00Z' + ``` .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -After '2021-01-01T00:00:00Z' + ``` .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Ref 'refs/heads/main' + ``` .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Actor 'octocat' + ``` .EXAMPLE + ```pwsh $params = @{ Owner = 'PSModule' Repo = 'GitHub' @@ -39,11 +54,14 @@ } Get-GitHubRepositoryActivity @params | Select-Object -Property @{n='actor';e={$_.actor.login}},activity_type,ref,timestamp + ``` Gets the activity for the past 24 hours and selects the actor, activity type, ref, and timestamp. .EXAMPLE + ```pwsh Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -ActivityType 'push','force_push' + ``` .NOTES [List repository activities](https://docs.github.com/rest/repos/repos#list-repository-activities) diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 index 20d8ae32f..306f22bd7 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryCodeownersError { +filter Get-GitHubRepositoryCodeownersError { <# .SYNOPSIS List CODEOWNERS errors @@ -10,7 +10,9 @@ see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." .EXAMPLE + ```pwsh Get-GitHubRepositoryCodeownersError -Owner 'PSModule' -Name 'GitHub' + ``` Gets the CODEOWNERS errors for the repository. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 index fe85303fd..534c12f07 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryContributor { +filter Get-GitHubRepositoryContributor { <# .SYNOPSIS List repository contributors @@ -12,7 +12,9 @@ in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. .EXAMPLE + ```pwsh Get-GitHubRepositoryContributor -Owner 'PSModule' -Name 'GitHub' + ``` Gets all contributors to the GitHub repository. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 index d9d6ab9f9..5606a21a8 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryFork { +filter Get-GitHubRepositoryFork { <# .SYNOPSIS List forks @@ -7,7 +7,9 @@ List forks of a named repository. .EXAMPLE + ```pwsh Get-GitHubRepositoryFork -Owner 'octocat' -Name 'Hello-World' + ``` List forks of the 'Hello-World' repository owned by 'octocat'. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 index 19c67c1e0..cbc36f5c3 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryLanguage { +filter Get-GitHubRepositoryLanguage { <# .SYNOPSIS List repository languages @@ -8,7 +8,9 @@ bytes of code written in that language. .EXAMPLE + ```pwsh Get-GitHubRepositoryLanguage -Owner 'octocat' -Name 'hello-world' + ``` Gets the languages for the 'hello-world' repository owned by 'octocat'. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 index c1c190893..da362f43c 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositorySecurityFix { +filter Get-GitHubRepositorySecurityFix { <# .SYNOPSIS Check if automated security fixes are enabled for a repository @@ -9,7 +9,9 @@ "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". .EXAMPLE + ```pwsh Get-GitHubRepositorySecurityFix -Owner 'PSModule' -Name 'GitHub' + ``` Gets the automated security fixes status for the GitHub repository. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 index c0b990b43..a411aaedd 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryTag { +filter Get-GitHubRepositoryTag { <# .SYNOPSIS List repository tags @@ -7,7 +7,9 @@ List repository tags .EXAMPLE + ```pwsh Get-GitHubRepositoryTag -Owner 'PSModule' -Name 'GitHub' + ``` Gets all tags of the GitHub repository. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 index f448e6163..4ae146075 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryTeam { +filter Get-GitHubRepositoryTeam { <# .SYNOPSIS List repository teams @@ -15,7 +15,9 @@ This endpoint is not compatible with fine-grained personal access tokens. .EXAMPLE + ```pwsh Get-GitHubRepositoryTeam -Owner 'PSModule' -Name 'GitHub' + ``` Lists the teams that have access to the specified repository and that are also visible to the authenticated user. diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 index b2a9aeabb..350e8e949 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryTopic { +filter Get-GitHubRepositoryTopic { <# .SYNOPSIS Get all repository topics @@ -7,6 +7,8 @@ Get all repository topics .EXAMPLE + ```pwsh + ``` .NOTES [Get all repository topics](https://docs.github.com/rest/repos/repos#get-all-repository-topics) diff --git a/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 index 93ca0c5b1..c9d2e3611 100644 --- a/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 +++ b/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubRepositoryTopic { +filter Set-GitHubRepositoryTopic { <# .SYNOPSIS Replace all repository topics @@ -7,7 +7,9 @@ Replace all repository topics .EXAMPLE + ```pwsh Set-GitHubRepositoryTopic -Owner 'octocat' -Name 'hello-world' -Topic 'octocat', 'octo', 'octocat/hello-world' + ``` Replaces all topics for the repository 'octocat/hello-world' with the topics 'octocat', 'octo', 'octocat/hello-world'. diff --git a/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 b/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 index eb4fef843..21327b620 100644 --- a/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 +++ b/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 @@ -1,4 +1,4 @@ -filter Start-GitHubRepositoryEvent { +filter Start-GitHubRepositoryEvent { <# .SYNOPSIS Create a repository dispatch event @@ -25,6 +25,7 @@ This input example shows how you can use the `client_payload` as a test to debug your workflow. .EXAMPLE + ```pwsh $params = @{ EventType = 'on-demand-test' ClientPayload = @{ @@ -33,6 +34,7 @@ } } Start-GitHubRepositoryEvent @params + ``` Starts a repository event with the name `on-demand-test` and a `client_payload` that includes `unit` and `integration`. diff --git a/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 index c4bf7ebaf..fc3212211 100644 --- a/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubRepositoryVulnerabilityAlert { +filter Test-GitHubRepositoryVulnerabilityAlert { <# .SYNOPSIS Check if vulnerability alerts are enabled for a repository @@ -10,7 +10,9 @@ "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". .EXAMPLE + ```pwsh Test-GitHubRepositoryVulnerabilityAlert -Owner 'PSModule' -Name 'GitHub' + ``` Checks if vulnerability alerts are enabled for the PSModule/GitHub repository. diff --git a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 index 741f9e9b3..1cd580fae 100644 --- a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 +++ b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryRuleSuite { +filter Get-GitHubRepositoryRuleSuite { <# .SYNOPSIS List repository rule suites or a rule suite by ID. @@ -9,6 +9,7 @@ For more information, see"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Repo = 'hello-world' @@ -18,11 +19,14 @@ RuleSuiteResult = 'all' } Get-GitHubRepositoryRuleSuite @params + ``` Gets a list of rule suites for the main branch of the hello-world repository owned by octocat. .EXAMPLE + ```pwsh Get-GitHubRepositoryRuleSuite -Owner 'octocat' -Repository 'hello-world' -RuleSuiteId 123456789 + ``` Gets information about a suite of rule evaluations with ID 123456789 from within the octocat/hello-world repository. diff --git a/src/functions/public/Repositories/Set-GitHubRepository.ps1 b/src/functions/public/Repositories/Set-GitHubRepository.ps1 index 2035521dc..9c6b45751 100644 --- a/src/functions/public/Repositories/Set-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Set-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubRepository { +function Set-GitHubRepository { <# .SYNOPSIS Creates or updates a repository. @@ -9,12 +9,15 @@ provided parameters. The updated or newly created repository is returned. .EXAMPLE + ```pwsh Set-GitHubRepository -Name 'Hello-World' -Description 'My repo' + ``` Sets the repository `Hello-World` for the authenticated user if it does not exist, or updates it if it already exists. The repository uses GitHub's default settings. .EXAMPLE + ```pwsh $params = @{ Owner = 'octocat' Name = 'Hello-World' @@ -25,6 +28,7 @@ DeleteBranchOnMerge = $true } Set-GitHubRepository @params + ``` Sets a repository using splatting for the configuration. diff --git a/src/functions/public/Repositories/Update-GitHubRepository.ps1 b/src/functions/public/Repositories/Update-GitHubRepository.ps1 index 49a2ea15e..46068efed 100644 --- a/src/functions/public/Repositories/Update-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Update-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubRepository { +filter Update-GitHubRepository { <# .SYNOPSIS Update a repository @@ -9,11 +9,14 @@ .EXAMPLE ```pwsh + ```pwsh Update-GitHubRepository -Name 'octocat' -Description 'Hello-World' -Homepage 'https://github.com' ``` + ``` .EXAMPLE ```pwsh + ```pwsh $params = @{ Owner = 'octocat' Name = 'Hello-World' @@ -23,6 +26,7 @@ } Update-GitHubRepository @params ``` + ``` Updates the repository `Hello-World` owned by `octocat` with a new name, description, and homepage URL. diff --git a/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 b/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 index f92772834..e40af3428 100644 --- a/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 +++ b/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKey { +function Get-GitHubPublicKey { <# .SYNOPSIS Gets a public key. @@ -7,17 +7,23 @@ Gets your public key, which you need to encrypt secrets. .EXAMPLE + ```pwsh Get-GitHubPublicKey + ``` Gets a public key for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubPublicKey -Organization 'octocat' + ``` Gets a public key for the 'octocat' organization. .EXAMPLE + ```pwsh Get-GitHubPublicKey -Owner 'octocat' -Repository 'hello-world' -Type 'codespaces' + ``` Gets a public key for the 'hello-world' repository in the 'octocat' organization for codespaces. diff --git a/src/functions/public/Secrets/Get-GitHubSecret.ps1 b/src/functions/public/Secrets/Get-GitHubSecret.ps1 index 13c2adde2..00d65bd22 100644 --- a/src/functions/public/Secrets/Get-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Get-GitHubSecret.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecret { +function Get-GitHubSecret { <# .SYNOPSIS Retrieve GitHub secret(s) without revealing encrypted value(s). @@ -11,17 +11,23 @@ The function returns an array of PSObjects containing metadata about the secrets. .EXAMPLE + ```pwsh Get-GitHubSecret -Owner PSModule -Repo Demo -Type actions + ``` Retrieves all Actions secrets from the 'Demo' repository under the 'PSModule' organization. .EXAMPLE + ```pwsh Get-GitHubSecret -Owner PSModule -Type organization + ``` Retrieves all organization-level secrets under the 'PSModule' organization. .EXAMPLE + ```pwsh Get-GitHubSecret -Owner PSModule -Repo Demo -Environment Staging + ``` Retrieves all secrets for the 'Staging' environment in the 'Demo' repository under 'PSModule'. diff --git a/src/functions/public/Secrets/Remove-GitHubSecret.ps1 b/src/functions/public/Secrets/Remove-GitHubSecret.ps1 index f5ea7b3eb..bffacaa75 100644 --- a/src/functions/public/Secrets/Remove-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Remove-GitHubSecret.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecret { +function Remove-GitHubSecret { <# .SYNOPSIS Deletes a secret from GitHub. @@ -8,17 +8,23 @@ Supports both Actions and Codespaces secrets and requires appropriate authentication. .EXAMPLE + ```pwsh Remove-GitHubSecret -Owner PSModule -Repository Demo -Type actions -Name TEST + ``` Deletes the secret named 'TEST' from the 'Demo' repository in the 'PSModule' organization. .EXAMPLE + ```pwsh Remove-GitHubSecret -Organization MyOrg -Type actions -Name API_KEY + ``` Deletes the secret 'API_KEY' from the organization 'MyOrg'. .EXAMPLE + ```pwsh Remove-GitHubSecret -Owner MyUser -Repository MyRepo -Environment Production -Name DB_PASSWORD + ``` Deletes the 'DB_PASSWORD' secret from the 'Production' environment in the 'MyRepo' repository. diff --git a/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 index 56ed38a60..1159f5557 100644 --- a/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubSecretSelectedRepository { +function Add-GitHubSecretSelectedRepository { <# .SYNOPSIS Add selected repository to an organization secret. @@ -11,7 +11,9 @@ and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh Add-GitHubSecretSelectedRepository -Owner 'my-org' -Name 'API_KEY' -RepositoryID '654321' + ``` Adds the repository 'test-repo' to the 'API_KEY' secret in the organization 'my-org'. diff --git a/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 index 21c00582d..3d3989bcd 100644 --- a/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretSelectedRepository { +function Get-GitHubSecretSelectedRepository { <# .SYNOPSIS List selected repositories for an organization secret. @@ -9,10 +9,12 @@ need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE + ```pwsh Get-GitHubSecretSelectedRepository -Owner 'octocat' -Name 'hello-world' + ``` Outputs: - ```powershell + ```pwsh Name : hello-world NodeID : m_MDXNcwMAwMMA ID : 123456789 diff --git a/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 index e4c97e672..e46d9bccb 100644 --- a/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretSelectedRepository { +function Remove-GitHubSecretSelectedRepository { <# .SYNOPSIS Remove selected repository from an organization secret. @@ -10,7 +10,9 @@ tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE + ```pwsh Remove-GitHubSecretSelectedRepository -Owner 'my-org' -Name 'ENV_SECRET' -RepositoryID 123456 + ``` Removes repository with ID 123456 from the organization secret 'ENV_SECRET' in 'my-org'. diff --git a/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 index c82c5c0ce..c013242d7 100644 --- a/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretSelectedRepository { +function Set-GitHubSecretSelectedRepository { <# .SYNOPSIS Set selected repositories for an organization secret. @@ -10,7 +10,9 @@ tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE + ```pwsh Set-GitHubSecretSelectedRepository -Owner 'octocat' -Name 'mysecret' -RepositoryID 1234567890 + ``` Sets the selected repositories for the secret `mysecret` in the organization `octocat` to the repository with ID `1234567890`. diff --git a/src/functions/public/Secrets/Set-GitHubSecret.ps1 b/src/functions/public/Secrets/Set-GitHubSecret.ps1 index c1da2a007..1963d8642 100644 --- a/src/functions/public/Secrets/Set-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Set-GitHubSecret.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecret { +function Set-GitHubSecret { <# .SYNOPSIS Updates a GitHub secret for an organization, repository, or user. @@ -8,12 +8,15 @@ It encrypts the secret value before storing it and supports different visibility levels. .EXAMPLE + ```pwsh $secret = ConvertTo-SecureString "my-secret-value" -AsPlainText -Force Set-GitHubSecret -Repository 'MyRepo' -Owner 'MyUser' -Name 'MySecret' -Value $secret + ``` Updates the secret `MySecret` in the `MyRepo` repository for the owner `MyUser`. .EXAMPLE + ```pwsh $params = @{ Organization = 'MyOrg' Name = 'MySecret' @@ -22,10 +25,12 @@ Visibility = 'Private' } Set-GitHubSecret @params + ``` Updates the secret `MySecret` at the organization level for GitHub Actions, setting visibility to private. .EXAMPLE + ```pwsh $params = @{ Owner = 'MyUser' Repository = 'MyRepo' @@ -34,6 +39,7 @@ Value = (ConvertTo-SecureString "my-secret-value" -AsPlainText -Force) } Set-GitHubSecret @params + ``` Updates the secret `MySecret` in the `Production` environment of the `MyRepo` repository for `MyUser`. diff --git a/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 b/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 index df799f233..bdd856f94 100644 --- a/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 +++ b/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubScheduledMaintenance { +function Get-GitHubScheduledMaintenance { <# .SYNOPSIS Gets the status of GitHub scheduled maintenance @@ -13,18 +13,24 @@ Impact: None (black), Minor (yellow), Major (orange), or Critical (red) .EXAMPLE + ```pwsh Get-GitHubScheduledMaintenance + ``` Get a list of the 50 most recent scheduled maintenances. This includes scheduled maintenances as described in the above two endpoints, as well as those in the Completed state. .EXAMPLE + ```pwsh Get-GitHubScheduledMaintenance -Active + ``` Get a list of any active maintenances. .EXAMPLE + ```pwsh Get-GitHubScheduledMaintenance -Upcoming + ``` Get a list of any upcoming maintenances. diff --git a/src/functions/public/Status/Get-GitHubStatus.ps1 b/src/functions/public/Status/Get-GitHubStatus.ps1 index 8a0072f1b..77154f4b5 100644 --- a/src/functions/public/Status/Get-GitHubStatus.ps1 +++ b/src/functions/public/Status/Get-GitHubStatus.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubStatus { +function Get-GitHubStatus { <# .SYNOPSIS Gets the status of GitHub services @@ -11,12 +11,16 @@ and "Major Service Outage". .EXAMPLE + ```pwsh Get-GitHubStatus + ``` Gets the status of GitHub services .EXAMPLE + ```pwsh Get-GitHubStatus -Summary + ``` Gets a summary of the status page, including a status indicator, component statuses, unresolved incidents, and any upcoming or in-progress scheduled maintenances. diff --git a/src/functions/public/Status/Get-GitHubStatusComponent.ps1 b/src/functions/public/Status/Get-GitHubStatusComponent.ps1 index 130c5af14..57316a565 100644 --- a/src/functions/public/Status/Get-GitHubStatusComponent.ps1 +++ b/src/functions/public/Status/Get-GitHubStatusComponent.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubStatusComponent { +function Get-GitHubStatusComponent { <# .SYNOPSIS Gets the status of GitHub components @@ -8,7 +8,9 @@ degraded_performance, partial_outage, or major_outage. .EXAMPLE + ```pwsh Get-GitHubStatusComponent + ``` Gets the status of GitHub components diff --git a/src/functions/public/Status/Get-GitHubStatusIncident.ps1 b/src/functions/public/Status/Get-GitHubStatusIncident.ps1 index 146c88f94..cc59a1dcb 100644 --- a/src/functions/public/Status/Get-GitHubStatusIncident.ps1 +++ b/src/functions/public/Status/Get-GitHubStatusIncident.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubStatusIncident { +function Get-GitHubStatusIncident { <# .SYNOPSIS Gets the status of GitHub incidents @@ -12,12 +12,16 @@ Impact: None (black), Minor (yellow), Major (orange), or Critical (red) .EXAMPLE + ```pwsh Get-GitHubStatusIncident + ``` Gets the status of GitHub incidents .EXAMPLE + ```pwsh Get-GitHubStatusIncident -Unresolved + ``` Gets the status of GitHub incidents that are unresolved diff --git a/src/functions/public/Teams/Get-GitHubTeam.ps1 b/src/functions/public/Teams/Get-GitHubTeam.ps1 index befe3fd55..b986c69d7 100644 --- a/src/functions/public/Teams/Get-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Get-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubTeam { +function Get-GitHubTeam { <# .SYNOPSIS List teams from an org or get a team by name @@ -9,17 +9,23 @@ and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name. .EXAMPLE + ```pwsh Get-GitHubTeam -Organization 'GitHub' + ``` Gets all teams in the `github` organization. .EXAMPLE + ```pwsh Get-GitHubTeam -Organization 'github' -Slug 'my-team-name' + ``` Gets the team with the slug 'my-team-name' in the `github` organization. .EXAMPLE + ```pwsh Get-GitHubTeam -Organization 'github' -Repository 'my-repo' + ``` Lists all teams that have access to the 'my-repo' repository owned by `github`. diff --git a/src/functions/public/Teams/New-GitHubTeam.ps1 b/src/functions/public/Teams/New-GitHubTeam.ps1 index 05f4178a1..a3193a96a 100644 --- a/src/functions/public/Teams/New-GitHubTeam.ps1 +++ b/src/functions/public/Teams/New-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function New-GitHubTeam { +function New-GitHubTeam { <# .SYNOPSIS Create a team @@ -13,6 +13,7 @@ "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". .EXAMPLE + ```pwsh $params = @{ Organization = 'github' Name = 'team-name' @@ -21,6 +22,7 @@ Notifications = $true } New-GitHubTeam @params + ``` .LINK https://psmodule.io/GitHub/Functions/Teams/New-GitHubTeam diff --git a/src/functions/public/Teams/Remove-GitHubTeam.ps1 b/src/functions/public/Teams/Remove-GitHubTeam.ps1 index b795eca9a..24168b13a 100644 --- a/src/functions/public/Teams/Remove-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Remove-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubTeam { +function Remove-GitHubTeam { <# .SYNOPSIS Delete a team @@ -8,7 +8,9 @@ If you are an organization owner, deleting a parent team will delete all of its child teams as well. .EXAMPLE + ```pwsh Remove-GitHubTeam -Organization 'github' -Name 'team-name' + ``` .NOTES [Delete a team](https://docs.github.com/rest/teams/teams#delete-a-team) diff --git a/src/functions/public/Teams/Update-GitHubTeam.ps1 b/src/functions/public/Teams/Update-GitHubTeam.ps1 index 642122513..4db8741f8 100644 --- a/src/functions/public/Teams/Update-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Update-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubTeam { +function Update-GitHubTeam { <# .SYNOPSIS Update a team @@ -7,6 +7,7 @@ To edit a team, the authenticated user must either be an organization owner or a team maintainer. .EXAMPLE + ```pwsh $params = @{ Organization = 'github' Slug = 'team-name' @@ -17,6 +18,7 @@ ParentTeamID = 123456 } Update-GitHubTeam @params + ``` Updates the team with the slug 'team-name' in the `github` organization with the new name 'new team name', description 'A new team', visibility set to 'closed', notifications enabled, and the parent team ID set to 123456. diff --git a/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 b/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 index 641d5b63a..68ede73bc 100644 --- a/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 +++ b/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 @@ -1,4 +1,4 @@ -filter Block-GitHubUser { +filter Block-GitHubUser { <# .SYNOPSIS Block a user from user or an organization. @@ -8,13 +8,17 @@ If the user cannot be blocked false is returned. .EXAMPLE + ```pwsh Block-GitHubUser -Username 'octocat' + ``` Blocks the user 'octocat' for the authenticated user. Returns $true if successful, $false if not. .EXAMPLE + ```pwsh Block-GitHubUser -Organization 'GitHub' -Username 'octocat' + ``` Blocks the user 'octocat' from the organization 'GitHub'. Returns $true if successful, $false if not. diff --git a/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 index 70b16658e..01afcf0e5 100644 --- a/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 +++ b/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBlockedUser { +filter Get-GitHubBlockedUser { <# .SYNOPSIS List blocked users. @@ -7,12 +7,16 @@ List the users that are blocked on your personal account or a given organization. .EXAMPLE + ```pwsh Get-GitHubBlockedUser + ``` Returns a list of users blocked by the authenticated user. .EXAMPLE + ```pwsh Get-GitHubBlockedUser -Organization 'github' + ``` Lists all users blocked by the organization `github`. diff --git a/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 index 831ad3ed2..0ddb7e244 100644 --- a/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 +++ b/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubBlockedUser { +filter Test-GitHubBlockedUser { <# .SYNOPSIS Check if a user is blocked by the authenticated user or an organization. @@ -8,13 +8,17 @@ Returns a 404 if the given user is not blocked, or if the given user account has been identified as spam by GitHub. .EXAMPLE + ```pwsh Test-GitHubBlockedUser -Username 'octocat' + ``` Checks if the user `octocat` is blocked by the authenticated user. Returns true if the user is blocked, false if not. .EXAMPLE + ```pwsh Test-GitHubBlockedUser -Organization 'github' -Username 'octocat' + ``` Checks if the user `octocat` is blocked by the organization `github`. Returns true if the user is blocked, false if not. diff --git a/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 b/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 index 1f731eeeb..22fdf56ec 100644 --- a/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 +++ b/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 @@ -1,4 +1,4 @@ -filter Unblock-GitHubUser { +filter Unblock-GitHubUser { <# .SYNOPSIS Unblock a user @@ -7,13 +7,17 @@ Unblocks the given user and returns true. .EXAMPLE + ```pwsh Unblock-GitHubUser -Username 'octocat' + ``` Unblocks the user 'octocat' for the authenticated user. Returns $true if successful. .EXAMPLE + ```pwsh Unblock-GitHubUser -Organization 'GitHub' -Username 'octocat' + ``` Unblocks the user 'octocat' from the organization 'GitHub'. Returns $true if successful. diff --git a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 index 7c89e63ae..d03336ad9 100644 --- a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserEmail { +filter Add-GitHubUserEmail { <# .SYNOPSIS Add an email address for the authenticated user @@ -8,8 +8,10 @@ .EXAMPLE ```pwsh + ```pwsh Add-GitHubUserEmail -Email 'octocat@github.com','firstname.lastname@work.com' ``` + ``` Adds the email addresses `octocat@github.com` and `firstname.lastname@work.com` to the authenticated user's account. diff --git a/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 index 2fc0df686..7bf9caa3f 100644 --- a/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserEmail { +filter Get-GitHubUserEmail { <# .SYNOPSIS List email addresses for the authenticated user @@ -9,12 +9,16 @@ authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. .EXAMPLE + ```pwsh Get-GitHubUserEmail + ``` Gets all email addresses for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserEmail -Public + ``` Gets the publicly visible email address for the authenticated user. diff --git a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 index 4e81fdfa5..bdb6b6349 100644 --- a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserEmail { +filter Remove-GitHubUserEmail { <# .SYNOPSIS Delete an email address for the authenticated user @@ -8,8 +8,10 @@ .EXAMPLE ```pwsh + ```pwsh Remove-GitHubUserEmail -Emails 'octocat@github.com','firstname.lastname@work.com' ``` + ``` Removes the email addresses `octocat@github.com` and `firstname.lastname@work.com` from the authenticated user's account. diff --git a/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 b/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 index 67ee2bb42..b40cc175d 100644 --- a/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 +++ b/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubUserEmailVisibility { +filter Update-GitHubUserEmailVisibility { <# .SYNOPSIS Set primary email visibility for the authenticated user @@ -7,12 +7,16 @@ Sets the visibility for your primary email addresses. .EXAMPLE + ```pwsh Set-GitHubUserEmailVisibility -Visibility Public + ``` Sets the visibility for your primary email addresses to public. .EXAMPLE + ```pwsh Set-GitHubUserEmailVisibility -Visibility Private + ``` Sets the visibility for your primary email addresses to private. diff --git a/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 index b0f73ecb3..202e4392f 100644 --- a/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserFollowing { +filter Add-GitHubUserFollowing { <# .SYNOPSIS Follow a user @@ -9,7 +9,9 @@ Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. .EXAMPLE + ```pwsh Follow-GitHubUser -Username 'octocat' + ``` Follows the user with the username 'octocat'. diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 index 998df8a93..00d2b6f4d 100644 --- a/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 +++ b/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollower { +filter Get-GitHubUserFollower { <# .SYNOPSIS List followers of a given user or the authenticated user @@ -7,12 +7,16 @@ Lists the people following a given user or the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserFollower + ``` Gets all followers of the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserFollower -Username 'octocat' + ``` Gets all followers of the user 'octocat'. diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 index e24b7719f..c9e79f81a 100644 --- a/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowing { +filter Get-GitHubUserFollowing { <# .SYNOPSIS List the people a given user or the authenticated user follows @@ -7,12 +7,16 @@ Lists the people who a given user or the authenticated user follows. .EXAMPLE + ```pwsh Get-GitHubUserFollowing + ``` Gets all people the authenticated user follows. .EXAMPLE + ```pwsh Get-GitHubUserFollowing -Username 'octocat' + ``` Gets all people that 'octocat' follows. diff --git a/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 index 2b55d921c..b027317e1 100644 --- a/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserFollowing { +filter Remove-GitHubUserFollowing { <# .SYNOPSIS Unfollow a user @@ -7,7 +7,9 @@ Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. .EXAMPLE + ```pwsh Unfollow-GitHubUser -Username 'octocat' + ``` Unfollows the user with the username 'octocat'. diff --git a/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 index 546698f3c..aa752587c 100644 --- a/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubUserFollowing { +filter Test-GitHubUserFollowing { <# .SYNOPSIS Check if a given user or the authenticated user follows a person @@ -8,13 +8,17 @@ Returns a 404 if the user is not followed by a given user or the authenticated user. .EXAMPLE + ```pwsh Test-GitHubUserFollowing -Follows 'octocat' Test-GitHubUserFollowing 'octocat' + ``` Checks if the authenticated user follows the user 'octocat'. .EXAMPLE + ```pwsh Test-GitHubUserFollowing -Username 'octocat' -Follows 'ratstallion' + ``` Checks if the user 'octocat' follows the user 'ratstallion'. diff --git a/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 index 3fcfc38df..eb29fc957 100644 --- a/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserGpgKey { +filter Add-GitHubUserGpgKey { <# .SYNOPSIS Create a GPG key for the authenticated user @@ -9,9 +9,11 @@ [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Add-GitHubUserGpgKey -Name 'GPG key for GitHub' -ArmoredPublicKey @' -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1 + ``` mQINBFnZ2ZIBEADQ2Z7Z7 -----END PGP PUBLIC KEY BLOCK----- diff --git a/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 index 9a1fc348a..262ddeec3 100644 --- a/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserGpgKey { +filter Get-GitHubUserGpgKey { <# .SYNOPSIS List GPG keys for a given user or the authenticated user @@ -7,17 +7,23 @@ Lists a given user's or the current user's GPG keys. .EXAMPLE + ```pwsh Get-GitHubUserGpgKey + ``` Gets all GPG keys for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserGpgKey -ID '1234567' + ``` Gets the GPG key with ID '1234567' for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserGpgKey -Username 'octocat' + ``` Gets all GPG keys for the 'octocat' user. diff --git a/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 index b577a1fff..92cbaf223 100644 --- a/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 @@ -9,7 +9,9 @@ filter Remove-GitHubUserGpgKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Remove-GitHubUserGpgKey -ID '1234567' + ``` Gets the GPG key with ID '1234567' for the authenticated user. diff --git a/src/functions/public/Users/Get-GitHubUser.ps1 b/src/functions/public/Users/Get-GitHubUser.ps1 index 4e84bbf74..962004dba 100644 --- a/src/functions/public/Users/Get-GitHubUser.ps1 +++ b/src/functions/public/Users/Get-GitHubUser.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubUser { +function Get-GitHubUser { <# .SYNOPSIS List user(s) @@ -9,17 +9,23 @@ Lists all users, in the order that they signed up on GitHub - if '-All' is provided. .EXAMPLE + ```pwsh Get-GitHubUser + ``` Get the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUser -Name 'octocat' + ``` Get the 'octocat' user. .EXAMPLE + ```pwsh Get-GitHubUser -All -Since 17722253 + ``` Get a list of users, starting with the user 'MariusStorhaug'. diff --git a/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 index e16740d1d..e83d793b6 100644 --- a/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserKey { +filter Add-GitHubUserKey { <# .SYNOPSIS Create a public SSH key for the authenticated user @@ -9,7 +9,9 @@ [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Add-GitHubUserKey -Title 'ssh-rsa AAAAB3NzaC1yc2EAAA' -Key '2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234' + ``` Adds a new public SSH key to the authenticated user's GitHub account. diff --git a/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 index 69145a9d7..95b61850e 100644 --- a/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserKey { +filter Get-GitHubUserKey { <# .SYNOPSIS List public SSH keys for a given user or the authenticated user. @@ -10,17 +10,23 @@ Keys from a given user are accessible by anyone. .EXAMPLE + ```pwsh Get-GitHubUserKey + ``` Gets all GPG keys for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserKey -ID '1234567' + ``` Gets the public SSH key with the ID '1234567' for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserKey -Username 'octocat' + ``` Gets all GPG keys for the 'octocat' user. diff --git a/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 index 661cc342d..9954e433a 100644 --- a/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 @@ -9,7 +9,9 @@ filter Remove-GitHubUserKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE + ```pwsh Remove-GitHubUserKey -ID '1234567' + ``` Deletes the public SSH key with ID '1234567' from the authenticated user's GitHub account. diff --git a/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 index 648782a91..49fe11e69 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserSigningKey { +filter Add-GitHubUserSigningKey { <# .SYNOPSIS Create a SSH signing key for the authenticated user @@ -10,7 +10,9 @@ "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE + ```pwsh Add-GitHubUserSigningKey -Title 'ssh-rsa AAAAB3NzaC1yc2EAAA' -Key '2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234' + ``` Creates a new SSH signing key for the authenticated user's GitHub account. diff --git a/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 index 1b6da1cdc..2e78e2262 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserSigningKey { +filter Get-GitHubUserSigningKey { <# .SYNOPSIS List SSH signing keys for a given user or the authenticated user. @@ -7,17 +7,23 @@ Lists a given user's or the current user's SSH signing keys. .EXAMPLE + ```pwsh Get-GitHubUserSigningKey + ``` Gets all SSH signing keys for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserSigningKey -ID '1234567' + ``` Gets the SSH signing key with the ID '1234567' for the authenticated user. .EXAMPLE + ```pwsh Get-GitHubUserSigningKey -Username 'octocat' + ``` Gets all SSH signing keys for the 'octocat' user. diff --git a/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 index f9fdd5154..d6080c132 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 @@ -10,7 +10,9 @@ filter Remove-GitHubUserSigningKey { "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE + ```pwsh Remove-GitHubUserSigningKey -ID '1234567' + ``` Removes the SSH signing key with the ID of `1234567` from the authenticated user's GitHub account. diff --git a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 index 879f6e770..0ccde45d3 100644 --- a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserSocial { +filter Add-GitHubUserSocial { <# .SYNOPSIS Add social accounts for the authenticated user @@ -8,8 +8,10 @@ .EXAMPLE ```pwsh + ```pwsh Add-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount', 'https://www.linkedin.com/company/MyCompany' ``` + ``` Adds the Twitter and LinkedIn accounts to the authenticated user's profile. diff --git a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 index 8b85a69c4..9b8513add 100644 --- a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserSocial { +filter Remove-GitHubUserSocial { <# .SYNOPSIS Delete social accounts for the authenticated user @@ -8,8 +8,10 @@ .EXAMPLE ```pwsh + ```pwsh Remove-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount' ``` + ``` .NOTES [Delete social accounts for the authenticated user](https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user) diff --git a/src/functions/public/Users/Update-GitHubUser.ps1 b/src/functions/public/Users/Update-GitHubUser.ps1 index 4f97098ec..461d07c7a 100644 --- a/src/functions/public/Users/Update-GitHubUser.ps1 +++ b/src/functions/public/Users/Update-GitHubUser.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubUser { +filter Update-GitHubUser { <# .SYNOPSIS Update the authenticated user @@ -9,17 +9,23 @@ displayed on your public profile or via the API. .EXAMPLE + ```pwsh Update-GitHubUser -Name 'octocat' + ``` Update the authenticated user's name to 'octocat' .EXAMPLE + ```pwsh Update-GitHubUser -Location 'San Francisco' + ``` Update the authenticated user's location to 'San Francisco' .EXAMPLE + ```pwsh Update-GitHubUser -Hireable $true -Description 'I love programming' + ``` Update the authenticated user's hiring availability to 'true' and their description to 'I love programming' diff --git a/src/functions/public/Variables/Export-GitHubVariable.ps1 b/src/functions/public/Variables/Export-GitHubVariable.ps1 index 8280f7808..c7393fb86 100644 --- a/src/functions/public/Variables/Export-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Export-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Export-GitHubVariable { +function Export-GitHubVariable { <# .SYNOPSIS Exports a GitHub variable to the local environment. @@ -12,7 +12,9 @@ The function accepts pipeline input, allowing GitHub variables retrieved using `Get-GitHubVariable` to be exported seamlessly. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'staging' | Export-GitHubVariable + ``` Exports the variables retrieved from the GitHub API to the local environment. diff --git a/src/functions/public/Variables/Get-GitHubVariable.ps1 b/src/functions/public/Variables/Get-GitHubVariable.ps1 index e582c014a..9b5ee9bf1 100644 --- a/src/functions/public/Variables/Get-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Get-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariable { +function Get-GitHubVariable { <# .SYNOPSIS Retrieves a variable from GitHub based on the specified scope. @@ -11,10 +11,12 @@ `admin:org` for organizations, and collaborator access for environments. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' + ``` Output: - ```powershell + ```pwsh Name : HOST_NAME Value : github.com Owner : octocat @@ -25,10 +27,12 @@ Retrieves the specified variable from the organization level. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'GUID' + ``` Output: - ```powershell + ```pwsh Name : GUID Value : 354aa0b0-65b1-46c8-9c3e-1576f4167a41 Owner : octocat @@ -39,10 +43,12 @@ Retrieves the specified variable from the repository level. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'DB_SERVER' + ``` Output: - ```powershell + ```pwsh Name : DB_SERVER Value : db.example.com Owner : octocat @@ -53,10 +59,12 @@ Retrieves the specified variable from the environment level within a repository. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' + ``` Output: - ```powershell + ```pwsh Name : MAX_THREADS Value : 10 Owner : octocat @@ -73,10 +81,12 @@ Retrieves all variables available at the organization level. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' + ``` Output: - ```powershell + ```pwsh Name : LOG_LEVEL Value : INFO Owner : octocat @@ -93,10 +103,12 @@ Retrieves all variables available at the repository level. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'staging' + ``` Output: - ```powershell + ```pwsh Name : CACHE_DURATION Value : 3600 Owner : octocat diff --git a/src/functions/public/Variables/New-GitHubVariable.ps1 b/src/functions/public/Variables/New-GitHubVariable.ps1 index bba5c9cf0..b678d7515 100644 --- a/src/functions/public/Variables/New-GitHubVariable.ps1 +++ b/src/functions/public/Variables/New-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariable { +function New-GitHubVariable { <# .SYNOPSIS Creates a GitHub Actions variable at the organization, repository, or environment level. @@ -13,18 +13,24 @@ - Environment-level variables require collaborator access to the repository. .EXAMPLE + ```pwsh New-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Creates a new repository variable named `HOST_NAME` with the value `github.com` in the specified repository. .EXAMPLE + ```pwsh New-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Visibility 'all' -Context $GitHubContext + ``` Creates a new organization variable named `HOST_NAME` with the value `github.com` and makes it available to all repositories in the organization. .EXAMPLE + ```pwsh New-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Creates a new environment variable named `HOST_NAME` with the value `github.com` in the specified environment. diff --git a/src/functions/public/Variables/Remove-GitHubVariable.ps1 b/src/functions/public/Variables/Remove-GitHubVariable.ps1 index 578ad371c..0a07712f2 100644 --- a/src/functions/public/Variables/Remove-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Remove-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariable { +function Remove-GitHubVariable { <# .SYNOPSIS Deletes a GitHub variable from an organization, repository, or environment. @@ -14,17 +14,23 @@ - `repo` for repository and environment-level variables. .EXAMPLE + ```pwsh Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' | Remove-GitHubVariable + ``` Removes all variables retrieved from the specified repository. .EXAMPLE + ```pwsh Remove-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Context $GitHubContext + ``` Deletes the specified variable from the specified organization. .EXAMPLE + ```pwsh Remove-GitHubVariable -Variable $variablesArray + ``` Removes all variables provided in the array. diff --git a/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 index 37ce7cfcf..fdc6dcdf3 100644 --- a/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubVariableSelectedRepository { +function Add-GitHubVariableSelectedRepository { <# .SYNOPSIS Add selected repository to an organization variable. @@ -11,7 +11,9 @@ Fine-grained tokens must have 'Variables' organization permission (write) and 'Metadata' repository permission (read). .EXAMPLE + ```pwsh Add-GitHubVariableSelectedRepository -Owner 'my-org' -Name 'API_KEY' -RepositoryID '654321' + ``` Adds the repository 'test-repo' to the 'API_KEY' variable in the organization 'my-org'. diff --git a/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 index 6947ef247..99ba140c5 100644 --- a/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableSelectedRepository { +function Get-GitHubVariableSelectedRepository { <# .SYNOPSIS List selected repositories for an organization variable. @@ -10,7 +10,9 @@ the `repo` scope is also required. .EXAMPLE + ```pwsh Get-GitHubVariableSelectedRepository -Owner 'PSModule' -Name 'SELECTEDVAR' + ``` .OUTPUTS GitHubRepository diff --git a/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 index a81a40bac..6fbe68998 100644 --- a/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableSelectedRepository { +function Remove-GitHubVariableSelectedRepository { <# .SYNOPSIS Remove selected repository from an organization variable. @@ -16,7 +16,9 @@ 'Metadata' repository permissions (read). .EXAMPLE + ```pwsh Remove-GitHubVariableSelectedRepository -Owner 'my-org' -Name 'ENV_SECRET' -RepositoryID 123456 + ``` Removes repository with ID 123456 from the organization variable 'ENV_SECRET' in 'my-org'. diff --git a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 index 24e99861b..2a0b85bfe 100644 --- a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubVariableSelectedRepository { +function Set-GitHubVariableSelectedRepository { <# .SYNOPSIS Set selected repositories for an organization variable. @@ -10,6 +10,8 @@ OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE + ```pwsh + ``` .LINK https://psmodule.io/GitHub/Functions/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository diff --git a/src/functions/public/Variables/Set-GitHubVariable.ps1 b/src/functions/public/Variables/Set-GitHubVariable.ps1 index 83f9de664..9e9c79ec1 100644 --- a/src/functions/public/Variables/Set-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Set-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubVariable { +function Set-GitHubVariable { <# .SYNOPSIS Creates or updates a GitHub Actions variable at the organization, repository, or environment level. @@ -13,18 +13,24 @@ - Environment-level variables require collaborator access to the repository. .EXAMPLE + ```pwsh Set-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Creates or updates a repository variable named `HOST_NAME` with the value `github.com` in the specified repository. .EXAMPLE + ```pwsh Set-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Visibility 'all' -Context $GitHubContext + ``` Creates or updates an organization variable named `HOST_NAME` with the value `github.com` and makes it available to all repositories in the organization. .EXAMPLE + ```pwsh Set-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext + ``` Creates or updates an environment variable named `HOST_NAME` with the value `github.com` in the specified environment. diff --git a/src/functions/public/Variables/Update-GitHubVariable.ps1 b/src/functions/public/Variables/Update-GitHubVariable.ps1 index 74bf59393..e6933f406 100644 --- a/src/functions/public/Variables/Update-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Update-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariable { +function Update-GitHubVariable { <# .SYNOPSIS Update a GitHub variable at the organization, repository, or environment level. @@ -12,17 +12,23 @@ and environment variables require collaborator access. .EXAMPLE + ```pwsh Update-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' + ``` Updates the repository variable named `HOST_NAME` with the value `github.com` in the specified repository. .EXAMPLE + ```pwsh Update-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Visibility 'private' + ``` Updates the organization variable named `HOST_NAME` with the value `github.com`, making it private. .EXAMPLE + ```pwsh Update-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Value 'github.com' + ``` Updates the environment variable named `HOST_NAME` with the value `github.com` in the specified environment. diff --git a/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 index cfaa54435..4a05e893a 100644 --- a/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookConfiguration { +function Get-GitHubAppWebhookConfiguration { <# .SYNOPSIS Get a webhook configuration for an app @@ -11,7 +11,9 @@ to access this endpoint. .EXAMPLE + ```pwsh Get-GitHubAppWebhookConfiguration + ``` Returns the webhook configuration for the authenticated app. diff --git a/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 b/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 index 70c3a049e..6cfeed1d2 100644 --- a/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 +++ b/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDelivery { +function Get-GitHubAppWebhookDelivery { <# .SYNOPSIS List deliveries for an app webhook or get a delivery for an app webhook by ID. @@ -10,12 +10,16 @@ to access this endpoint. .EXAMPLE + ```pwsh Get-GitHubAppWebhookDelivery + ``` Returns a list of webhook deliveries for the webhook for the authenticated app. .EXAMPLE + ```pwsh Get-GitHubAppWebhookDelivery -ID 123456 + ``` Returns the webhook delivery with the ID `123456` for the authenticated app. diff --git a/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 b/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 index c1a649b3a..af6536b76 100644 --- a/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 +++ b/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 @@ -1,4 +1,4 @@ -function Invoke-GitHubAppWebhookReDelivery { +function Invoke-GitHubAppWebhookReDelivery { <# .SYNOPSIS Redeliver a delivery for an app webhook @@ -10,7 +10,9 @@ to access this endpoint. .EXAMPLE + ```pwsh Invoke-GitHubAppWebhookReDelivery -ID 12345 + ``` Redelivers the delivery with the ID `12345`. diff --git a/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 b/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 index a7e53b49a..469048eb5 100644 --- a/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 +++ b/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubWebhookSignature { +function Test-GitHubWebhookSignature { <# .SYNOPSIS Verifies a GitHub webhook signature using a shared secret. @@ -10,20 +10,24 @@ timing attacks. The function returns a boolean indicating whether the signature is valid. .EXAMPLE + ```pwsh Test-GitHubWebhookSignature -Secret $env:WEBHOOK_SECRET -Body $Request.RawBody -Signature $Request.Headers['X-Hub-Signature-256'] + ``` Output: - ```powershell + ```pwsh True ``` Validates the provided webhook payload against the HMAC SHA-256 signature using the given secret. .EXAMPLE + ```pwsh Test-GitHubWebhookSignature -Secret $env:WEBHOOK_SECRET -Request $Request + ``` Output: - ```powershell + ```pwsh True ``` diff --git a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 index a92f69ddb..ce02e7fbd 100644 --- a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubAppWebhookConfiguration { +function Update-GitHubAppWebhookConfiguration { <# .SYNOPSIS Update a webhook configuration for an app @@ -12,11 +12,13 @@ .EXAMPLE ```pwsh + ```pwsh Update-GitHubAppWebhookConfiguration -URL 'https://example.com' -ContentType 'json' -Secret 'mysecret' -EnableSsl ``` + ``` Output: - ```powershell + ```pwsh ContentType: json UseSsl: True Secret: mysecret diff --git a/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 index 8e7cf2661..fdedb8374 100644 --- a/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubWorkflow { +filter Disable-GitHubWorkflow { <# .SYNOPSIS Disable a workflow. @@ -8,6 +8,8 @@ For example, you could use `main.yaml`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE + ```pwsh + ``` .INPUTS GitHubWorkflow diff --git a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 index 679c92ea3..54767532f 100644 --- a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubWorkflow { +filter Enable-GitHubWorkflow { <# .SYNOPSIS Enable a workflow @@ -11,15 +11,19 @@ .EXAMPLE ```pwsh + ```pwsh Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 'main.yaml' ``` + ``` Enables the workflow with the file name 'main.yaml' in the PSModule/GitHub repository. .EXAMPLE ```pwsh + ```pwsh Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 161335 ``` + ``` Enables the workflow with the ID 161335 in the PSModule/GitHub repository. diff --git a/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 index d9a4ba822..50cec1390 100644 --- a/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflow { +filter Get-GitHubWorkflow { <# .SYNOPSIS Lists the workflows in a repository. @@ -9,12 +9,16 @@ GitHub Apps must have the actions:read permission to use this endpoint. .EXAMPLE + ```pwsh Get-GitHubWorkflow -Owner 'octocat' -Repository 'hello-world' + ``` Gets all workflows in the 'octocat/hello-world' repository. .EXAMPLE + ```pwsh Get-GitHubWorkflow -Owner 'octocat' -Repository 'hello-world' -Name 'hello-world.yml' + ``` Gets the 'hello-world.yml' workflow in the 'octocat/hello-world' repository. diff --git a/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 index 60292b63f..0e1660d7b 100644 --- a/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflowRun { +filter Get-GitHubWorkflowRun { <# .SYNOPSIS List workflow runs for a repository or a workflow @@ -12,22 +12,30 @@ `event`, `head_sha`, `status`. .EXAMPLE + ```pwsh Get-GitHubWorkflowRun -Owner 'owner' -Repository 'repo' + ``` Lists all workflow runs for a repository. .EXAMPLE + ```pwsh Get-GitHubWorkflowRun -Owner 'owner' -Repository 'repo' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' + ``` Lists all workflow runs for a repository with the specified actor, branch, event, and status. .EXAMPLE + ```pwsh Get-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -ID '42' + ``` Gets all workflow runs for the workflow with the ID `42` in the repository `Hello-World` owned by `octocat`. .EXAMPLE + ```pwsh Get-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -Name 'nightly.yml' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' + ``` Gets all workflow runs for the workflow with the name `nightly.yml` in the repository `Hello-World` owned by `octocat` that were triggered by the user `octocat` on the branch `main` and have the status `success`. diff --git a/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 index cd92f4a61..64bfe10f5 100644 --- a/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 @@ -9,7 +9,9 @@ filter Remove-GitHubWorkflowRun { this endpoint. .EXAMPLE + ```pwsh Remove-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -ID 123456789 + ``` Deletes the workflow run with the ID 123456789 from the 'Hello-World' repository owned by 'octocat' diff --git a/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 index 4011fca79..15345b313 100644 --- a/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 @@ -1,4 +1,4 @@ -filter Restart-GitHubWorkflowRun { +filter Restart-GitHubWorkflowRun { <# .SYNOPSIS Re-run a workflow @@ -7,7 +7,9 @@ Re-runs your workflow run using its `run_id`. You can also specify a branch or tag name to re-run a workflow run from a branch .EXAMPLE + ```pwsh Start-GitHubWorkflowReRun -Owner 'octocat' -Repository 'Hello-World' -ID 123456789 + ``` .INPUTS GitHubWorkflowRun diff --git a/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 index c166b7573..547c4cfd7 100644 --- a/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 @@ -1,4 +1,4 @@ -filter Stop-GitHubWorkflowRun { +filter Stop-GitHubWorkflowRun { <# .SYNOPSIS Cancel a workflow run @@ -7,7 +7,9 @@ Cancels a workflow run using its `run_id`. You can use this endpoint to cancel a workflow run that is in progress or waiting .EXAMPLE + ```pwsh Stop-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -ID 123456789 + ``` Cancels the workflow run with the ID 123456789 from the 'Hello-World' repository owned by 'octocat'. diff --git a/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 index 3a651b57e..9bf684258 100644 --- a/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Start-GitHubWorkflow { +filter Start-GitHubWorkflow { <# .SYNOPSIS Start a workflow run using the workflow's ID. @@ -7,12 +7,14 @@ Start a workflow run using the workflow's ID. .EXAMPLE + ```pwsh Get-GitHubWorkflow | Where-Object name -NotLike '.*' | Start-GitHubWorkflow -Inputs @{ staticValidation = $true deploymentValidation = $false removeDeployment = $true prerelease = $false } + ``` .LINK https://psmodule.io/GitHub/Functions/Workflows/Start-GitHubWorkflow/ diff --git a/tools/utilities/New-FunctionTemplate.ps1 b/tools/utilities/New-FunctionTemplate.ps1 index af7bcd7cc..d0be8ebda 100644 --- a/tools/utilities/New-FunctionTemplate.ps1 +++ b/tools/utilities/New-FunctionTemplate.ps1 @@ -1,4 +1,4 @@ -function New-FunctionTemplate { +function New-FunctionTemplate { <# .SYNOPSIS Short description @@ -7,7 +7,9 @@ Long description .EXAMPLE + ```pwsh An example + ``` .NOTES [Ttle](link) From ebf18e375365143f596473b022a696ebd6339ba2 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 11:50:19 +0200 Subject: [PATCH 08/16] =?UTF-8?q?=F0=9F=A9=B9=20[Patch]:=20Update=20code?= =?UTF-8?q?=20examples=20in=20PowerShell=20functions=20to=20use=20'powersh?= =?UTF-8?q?ell'=20syntax=20highlighting=20for=20improved=20clarity?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 | 4 ++-- .../private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 | 2 +- .../Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 | 2 +- .../private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 | 2 +- .../Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 | 2 +- .../Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 | 2 +- .../Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 | 2 +- .../Get-GitHubAppInstallationForEnterpriseOrganization.ps1 | 2 +- .../GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 | 2 +- .../GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 | 2 +- .../private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 | 2 +- .../Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 | 2 +- .../private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 | 2 +- 13 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 b/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 index ce4349d4a..8fbabf597 100644 --- a/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 @@ -8,12 +8,12 @@ function Add-GitHubKeyVaultJWTSignature { The function supports authentication via Azure CLI or Az PowerShell module and returns the signed JWT as a secure string. .EXAMPLE - ```pwsh + ```powershell Add-GitHubKeyVaultJWTSignature -UnsignedJWT 'header.payload' -KeyVaultKeyReference 'https://myvault.vault.azure.net/keys/mykey' ``` Output: - ```pwsh + ```powershell System.Security.SecureString ``` diff --git a/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 b/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 index 906fd35b5..0d7d7606e 100644 --- a/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 @@ -8,7 +8,7 @@ function Add-GitHubLocalJWTSignature { This function handles the RSA signing process and returns the complete signed JWT. .EXAMPLE - ```pwsh + ```powershell Add-GitHubLocalJWTSignature -UnsignedJWT 'eyJ0eXAiOi...' -PrivateKey '--- BEGIN RSA PRIVATE KEY --- ... --- END RSA PRIVATE KEY ---' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 index c4b51ed75..0ef0a5335 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 @@ -13,7 +13,7 @@ filter Get-GitHubAppAsAuthenticatedApp { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppAsAuthenticatedApp ``` diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 index acbc0394a..dc3d4ff8a 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 @@ -7,7 +7,7 @@ function Get-GitHubAppBySlug { Gets a single GitHub App using the app's slug. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppByName -AppSlug 'github-actions' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 index 7484df062..37961094f 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 @@ -11,7 +11,7 @@ function Get-GitHubAppInstallableOrganization { - enterprise_organization_installations: read .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppInstallableOrganization -Enterprise 'msx' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 index a2f616bb8..12da2d951 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 @@ -10,7 +10,7 @@ function Get-GitHubAppInstallationForAuthenticatedAppAsList { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppInstallationForAuthenticatedAppAsList ``` diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 index 9d6bd22a3..f515baf8c 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 @@ -10,7 +10,7 @@ function Get-GitHubAppInstallationForAuthenticatedAppByID { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppInstallationForAuthenticatedAppByID -ID 123456 ``` diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 index 77ae6c0a1..82d30e239 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 @@ -9,7 +9,7 @@ function Get-GitHubAppInstallationForEnterpriseOrganization { The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (read) permission. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppInstallationForEnterpriseOrganization -Enterprise 'msx' -Organization 'github' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 index 160df468c..547195200 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 @@ -8,7 +8,7 @@ function Get-GitHubAppInstallationForOrganization { You must be an organization owner with `admin:read` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppInstallationForOrganization -Organization 'github' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 index 9e56bbde7..a500a9697 100644 --- a/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 @@ -9,7 +9,7 @@ function Install-GitHubAppOnEnterpriseOrganization { The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (write) permission. .EXAMPLE - ```pwsh + ```powershell Install-GitHubAppOnEnterpriseOrganization -Enterprise 'msx' -Organization 'org' -ClientID '123456' ``` #> diff --git a/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 b/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 index d266ff06b..50189f1f2 100644 --- a/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 +++ b/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 @@ -9,7 +9,7 @@ function New-GitHubUnsignedJWT { that can be passed to a signing function. .EXAMPLE - ```pwsh + ```powershell New-GitHubUnsignedJWT -ClientId 'Iv987654321' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 b/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 index 3245c2eb4..31d1ecf98 100644 --- a/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 @@ -7,7 +7,7 @@ function Test-GitHubJWTRefreshRequired { Test if the GitHub JWT should be refreshed. JWTs are refreshed when they have 150 seconds or less remaining before expiration. .EXAMPLE - ```pwsh + ```powershell Test-GitHubJWTRefreshRequired -Context $Context ``` diff --git a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 index f90e508fc..fb58c7bba 100644 --- a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 @@ -7,7 +7,7 @@ function Uninstall-GitHubAppAsApp { Deletes a GitHub App installation using the authenticated App context. .EXAMPLE - ```pwsh + ```powershell Uninstall-GitHubAppAsApp -ID 123456 -Context $appContext ``` From 9b52d345c5a08893a2390621c75a161bc702dbf7 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 12:07:18 +0200 Subject: [PATCH 09/16] Fix --- .../Actions/Import-GitHubEventData.ps1 | 2 +- .../Actions/Import-GitHubRunnerData.ps1 | 2 +- .../Get-GitHubWorkflowRunByRepo.ps1 | 4 ++-- .../Get-GitHubWorkflowRunByWorkflow.ps1 | 4 ++-- ...tall-GitHubAppOnEnterpriseOrganization.ps1 | 2 +- .../Apps/GitHub Apps/Update-GitHubAppJWT.ps1 | 6 ++--- .../Artifacts/Get-GitHubArtifactById.ps1 | 4 ++-- .../Get-GitHubArtifactFromRepository.ps1 | 4 ++-- .../Get-GitHubArtifactFromWorkflowRun.ps1 | 4 ++-- .../private/Auth/Cli/Connect-GithubCli.ps1 | 4 ++-- .../Auth/Context/Assert-GitHubContext.ps1 | 2 +- .../Auth/Context/Remove-GitHubContext.ps1 | 4 ++-- .../Auth/Context/Resolve-GitHubContext.ps1 | 4 ++-- .../Context/Resolve-GitHubContextSetting.ps1 | 12 +++++----- .../Auth/Context/Set-GitHubContext.ps1 | 2 +- .../Invoke-GitHubDeviceFlowLogin.ps1 | 2 +- .../DeviceFlow/Request-GitHubAccessToken.ps1 | 2 +- .../DeviceFlow/Request-GitHubDeviceCode.ps1 | 2 +- .../Test-GitHubAccessTokenRefreshRequired.ps1 | 2 +- .../Update-GitHubUserAccessToken.ps1 | 4 ++-- .../DeviceFlow/Wait-GitHubAccessToken.ps1 | 4 ++-- .../private/Auth/Get-GitHubToken.ps1 | 8 +++---- .../private/Auth/Test-GitHubToken.ps1 | 2 +- .../private/Branches/Get-GitHubBranchList.ps1 | 2 +- .../Commands/ConvertFrom-GitHubOutput.ps1 | 2 +- .../Config/Initialize-GitHubConfig.ps1 | 4 ++-- .../Core/ConvertTo-GitHubGraphQLField.ps1 | 2 +- .../Enterprise/Get-GitHubEnterpriseByName.ps1 | 4 ++-- .../Enterprise/Get-GitHubEnterpriseList.ps1 | 4 ++-- .../Get-GitHubEnvironmentByName.ps1 | 4 ++-- .../Get-GitHubEnvironmentList.ps1 | 4 ++-- .../Gitignore/Get-GitHubGitignoreByName.ps1 | 2 +- .../Gitignore/Get-GitHubGitignoreList.ps1 | 2 +- .../License/Get-GitHubLicenseByName.ps1 | 2 +- .../private/License/Get-GitHubLicenseList.ps1 | 2 +- .../License/Get-GitHubRepositoryLicense.ps1 | 2 +- .../Block-GitHubUserByOrganization.ps1 | 2 +- .../Get-GitHubBlockedUserByOrganization.ps1 | 2 +- .../Test-GitHubBlockedUserByOrganization.ps1 | 2 +- .../Unblock-GitHubUserByOrganization.ps1 | 2 +- .../Get-GitHubAllOrganization.ps1 | 2 +- .../Get-GitHubOrganizationByName.ps1 | 2 +- .../Get-GitHubOrganizationListForAuthUser.ps1 | 4 ++-- .../Get-GitHubUserOrganization.ps1 | 2 +- .../Assets/Get-GitHubReleaseAssetByID.ps1 | 2 +- .../Get-GitHubReleaseAssetByReleaseID.ps1 | 4 ++-- .../Assets/Get-GitHubReleaseAssetByTag.ps1 | 4 ++-- .../Get-GitHubReleaseAssetFromLatest.ps1 | 4 ++-- .../private/Releases/Get-GitHubReleaseAll.ps1 | 2 +- .../Releases/Get-GitHubReleaseByID.ps1 | 2 +- .../Releases/Get-GitHubReleaseByTagName.ps1 | 2 +- .../Releases/Get-GitHubReleaseLatest.ps1 | 2 +- .../Get-GitHubRepositoryAutolinkById.ps1 | 2 +- .../Get-GitHubRepositoryAutolinkList.ps1 | 2 +- .../Repositories/Get-GitHubMyRepositories.ps1 | 4 ++-- .../Get-GitHubMyRepositoryByName.ps1 | 2 +- .../Get-GitHubRepositoryByName.ps1 | 2 +- .../Get-GitHubRepositoryByNameAndTeam.ps1 | 4 ++-- .../Get-GitHubRepositoryListByOwner.ps1 | 6 ++--- .../Get-GitHubRepositoryListByTeam.ps1 | 4 ++-- .../New-GitHubRepositoryAsFork.ps1 | 8 +++---- .../New-GitHubRepositoryFromTemplate.ps1 | 2 +- .../Repositories/New-GitHubRepositoryOrg.ps1 | 2 +- .../Repositories/New-GitHubRepositoryUser.ps1 | 2 +- .../Get-GitHubRepositoryRuleSuiteById.ps1 | 2 +- .../Get-GitHubRepositoryRuleSuiteList.ps1 | 2 +- .../Get-GitHubSecretEnvironmentByName.ps1 | 4 ++-- .../Get-GitHubSecretEnvironmentList.ps1 | 4 ++-- .../Get-GitHubSecretFromOrganization.ps1 | 4 ++-- .../Secrets/Get-GitHubSecretOwnerByName.ps1 | 4 ++-- .../Secrets/Get-GitHubSecretOwnerList.ps1 | 4 ++-- .../Get-GitHubSecretRepositoryByName.ps1 | 4 ++-- .../Get-GitHubSecretRepositoryList.ps1 | 4 ++-- ...-GitHubPublicKeyForActionOnEnvironment.ps1 | 4 ++-- ...GitHubPublicKeyForActionOnOrganization.ps1 | 4 ++-- ...t-GitHubPublicKeyForActionOnRepository.ps1 | 4 ++-- ...ubPublicKeyForCodespacesOnOrganization.ps1 | 4 ++-- ...tHubPublicKeyForCodespacesOnRepository.ps1 | 4 ++-- ...Get-GitHubPublicKeyForCodespacesOnUser.ps1 | 4 ++-- .../Remove-GitHubSecretFromEnvironment.ps1 | 2 +- .../Secrets/Remove-GitHubSecretFromOwner.ps1 | 2 +- .../Remove-GitHubSecretFromRepository.ps1 | 2 +- .../Secrets/Set-GitHubSecretOnEnvironment.ps1 | 2 +- .../Secrets/Set-GitHubSecretOnOwner.ps1 | 2 +- .../Secrets/Set-GitHubSecretOnRepository.ps1 | 2 +- .../private/Teams/Get-GitHubTeamBySlug.ps1 | 2 +- .../private/Teams/Get-GitHubTeamListByOrg.ps1 | 2 +- .../Teams/Get-GitHubTeamListByRepo.ps1 | 4 ++-- .../Users/Blocking/Block-GitHubUserByUser.ps1 | 2 +- .../Blocking/Get-GitHubBlockedUserByUser.ps1 | 2 +- .../Blocking/Test-GitHubBlockedUserByUser.ps1 | 2 +- .../Blocking/Unblock-GitHubUserByUser.ps1 | 2 +- .../Users/Emails/Get-GitHubUserAllEmail.ps1 | 2 +- .../Emails/Get-GitHubUserPublicEmail.ps1 | 2 +- .../Get-GitHubUserFollowersOfUser.ps1 | 2 +- .../Followers/Get-GitHubUserFollowingMe.ps1 | 2 +- .../Followers/Get-GitHubUserFollowingUser.ps1 | 2 +- .../Followers/Get-GitHubUserMyFollower.ps1 | 2 +- .../Followers/Test-GitHubUserFollowedByMe.ps1 | 2 +- .../Test-GitHubUserFollowedByUser.ps1 | 2 +- .../GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 | 2 +- .../Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 | 2 +- .../GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 | 2 +- .../private/Users/Get-GitHubAllUser.ps1 | 2 +- .../private/Users/Get-GitHubMyUser.ps1 | 2 +- .../private/Users/Get-GitHubUserByName.ps1 | 2 +- .../Users/Keys/Get-GitHubUserKeyForUser.ps1 | 2 +- .../Users/Keys/Get-GitHubUserMyKey.ps1 | 2 +- .../Users/Keys/Get-GitHubUserMyKeyById.ps1 | 2 +- .../Get-GitHubUserMySigningKey.ps1 | 2 +- .../Get-GitHubUserMySigningKeyById.ps1 | 2 +- .../Get-GitHubUserSigningKeyForUser.ps1 | 2 +- .../Get-GitHubMyUserSocials.ps1 | 2 +- .../Get-GitHubUserSocialsByName.ps1 | 2 +- .../PowerShell/Get-FunctionParameter.ps1 | 6 ++--- .../PowerShell/Get-PSCallStackPath.ps1 | 6 ++--- .../PowerShell/Test-GitHubAzPowerShell.ps1 | 2 +- .../PowerShell/Test-GitHubAzureCLI.ps1 | 2 +- .../Get-GitHubVariableEnvironmentByName.ps1 | 4 ++-- .../Get-GitHubVariableEnvironmentList.ps1 | 4 ++-- .../Get-GitHubVariableFromOrganization.ps1 | 4 ++-- .../Get-GitHubVariableOwnerByName.ps1 | 4 ++-- .../Variables/Get-GitHubVariableOwnerList.ps1 | 4 ++-- .../Get-GitHubVariableRepositoryByName.ps1 | 4 ++-- .../Get-GitHubVariableRepositoryList.ps1 | 4 ++-- .../New-GitHubVariableOnEnvironment.ps1 | 2 +- .../Variables/New-GitHubVariableOnOwner.ps1 | 2 +- .../New-GitHubVariableOnRepository.ps1 | 2 +- .../Remove-GitHubVariableFromEnvironment.ps1 | 2 +- .../Remove-GitHubVariableFromOwner.ps1 | 2 +- .../Remove-GitHubVariableFromRepository.ps1 | 2 +- .../Update-GitHubVariableOnEnvironment.ps1 | 2 +- .../Update-GitHubVariableOnOwner.ps1 | 2 +- .../Update-GitHubVariableOnRepository.ps1 | 2 +- .../Get-GitHubAppWebhookDeliveryByID.ps1 | 2 +- .../Get-GitHubAppWebhookDeliveryByList.ps1 | 2 +- ...et-GitHubAppWebhookDeliveryToRedeliver.ps1 | 2 +- src/functions/public/API/Invoke-GitHubAPI.ps1 | 6 ++--- .../public/API/Invoke-GitHubGraphQLQuery.ps1 | 2 +- .../Actions/Data/Get-GitHubEventData.ps1 | 2 +- .../Actions/Data/Get-GitHubRunnerData.ps1 | 2 +- ...-GitHubAppInstallationRepositoryAccess.ps1 | 2 +- .../Get-GitHubAppAccessibleRepository.ps1 | 2 +- ...-GitHubAppInstallationRepositoryAccess.ps1 | 2 +- .../New-GitHubAppInstallationAccessToken.ps1 | 4 ++-- ...-GitHubAppInstallationRepositoryAccess.ps1 | 2 +- ...-GitHubAppInstallationRepositoryAccess.ps1 | 4 ++-- .../public/Apps/GitHub App/Get-GitHubApp.ps1 | 4 ++-- .../Get-GitHubAppInstallationRequest.ps1 | 2 +- .../Apps/GitHub App/Install-GitHubApp.ps1 | 4 ++-- .../Apps/GitHub App/Uninstall-GitHubApp.ps1 | 8 +++---- .../public/Artifacts/Get-GitHubArtifact.ps1 | 16 ++++++------- .../Artifacts/Remove-GitHubArtifact.ps1 | 2 +- .../public/Artifacts/Save-GitHubArtifact.ps1 | 8 +++---- .../public/Auth/Connect-GitHubAccount.ps1 | 8 +++---- .../public/Auth/Connect-GitHubApp.ps1 | 8 +++---- .../public/Auth/Context/Get-GitHubContext.ps1 | 2 +- .../Auth/Context/Switch-GitHubContext.ps1 | 2 +- .../public/Auth/Disconnect-GitHubAccount.ps1 | 8 +++---- .../public/Auth/Get-GitHubAccessToken.ps1 | 8 +++---- .../public/Auth/Get-GitHubViewer.ps1 | 2 +- .../public/Commands/Add-GitHubMask.ps1 | 4 ++-- .../public/Commands/Add-GitHubSystemPath.ps1 | 2 +- .../public/Commands/Disable-GitHubCommand.ps1 | 2 +- .../public/Commands/Enable-GitHubCommand.ps1 | 2 +- .../public/Commands/Get-GitHubOutput.ps1 | 4 ++-- .../public/Commands/Reset-GitHubOutput.ps1 | 2 +- .../Set-GitHubEnvironmentVariable.ps1 | 2 +- .../public/Commands/Set-GitHubLogGroup.ps1 | 4 ++-- .../Commands/Set-GitHubNoCommandGroup.ps1 | 4 ++-- .../public/Commands/Set-GitHubOutput.ps1 | 4 ++-- .../public/Commands/Set-GitHubStepSummary.ps1 | 2 +- .../public/Commands/Start-GitHubLogGroup.ps1 | 8 +++---- .../public/Commands/Stop-GitHubLogGroup.ps1 | 8 +++---- .../public/Commands/Write-GitHubDebug.ps1 | 2 +- .../public/Commands/Write-GitHubError.ps1 | 2 +- .../public/Commands/Write-GitHubLog.ps1 | 6 ++--- .../public/Commands/Write-GitHubNotice.ps1 | 2 +- .../public/Commands/Write-GitHubWarning.ps1 | 2 +- .../public/Config/Get-GitHubConfig.ps1 | 2 +- .../public/Config/Remove-GitHubConfig.ps1 | 2 +- .../public/Config/Reset-GitHubConfig.ps1 | 2 +- .../public/Config/Set-GitHubConfig.ps1 | 2 +- .../public/Emojis/Get-GitHubEmoji.ps1 | 4 ++-- .../Enterprise/Get-GitHubEnterprise.ps1 | 8 +++---- .../Get-GitHubEnterpriseOrganization.ps1 | 2 +- .../Environments/Get-GitHubEnvironment.ps1 | 8 +++---- .../Environments/Remove-GitHubEnvironment.ps1 | 2 +- .../Environments/Set-GitHubEnvironment.ps1 | 4 ++-- .../public/Git/Get-GitHubGitConfig.ps1 | 2 +- .../public/Git/Set-GitHubGitConfig.ps1 | 4 ++-- .../public/Gitignore/Get-GitHubGitignore.ps1 | 4 ++-- .../public/Issues/ConvertFrom-IssueForm.ps1 | 2 +- .../public/License/Get-GitHubLicense.ps1 | 6 ++--- .../public/Markdown/Get-GitHubMarkdown.ps1 | 2 +- .../public/Markdown/Get-GitHubMarkdownRaw.ps1 | 2 +- .../public/Meta/Get-GitHubApiVersion.ps1 | 2 +- src/functions/public/Meta/Get-GitHubMeta.ps1 | 2 +- .../public/Meta/Get-GitHubOctocat.ps1 | 4 ++-- src/functions/public/Meta/Get-GitHubRoot.ps1 | 2 +- src/functions/public/Meta/Get-GitHubZen.ps1 | 2 +- .../Organization/Get-GitHubOrganization.ps1 | 10 ++++---- ...et-GitHubOrganizationPendingInvitation.ps1 | 4 ++-- .../New-GitHubOrganizationInvitation.ps1 | 8 +++---- .../Remove-GitHubOrganizationInvitation.ps1 | 4 ++-- .../Organization/New-GitHubOrganization.ps1 | 4 ++-- .../Remove-GitHubOrganization.ps1 | 2 +- .../Update-GitHubOrganization.ps1 | 4 ++-- .../public/Rate-Limit/Get-GitHubRateLimit.ps1 | 2 +- .../Assets/Add-GitHubReleaseAsset.ps1 | 4 ++-- .../Assets/Get-GitHubReleaseAsset.ps1 | 8 +++---- .../Assets/Remove-GitHubReleaseAsset.ps1 | 2 +- .../Assets/Save-GitHubReleaseAsset.ps1 | 10 ++++---- .../Assets/Update-GitHubReleaseAsset.ps1 | 2 +- .../public/Releases/Get-GitHubRelease.ps1 | 8 +++---- .../public/Releases/New-GitHubRelease.ps1 | 10 ++++---- .../public/Releases/New-GitHubReleaseNote.ps1 | 6 ++--- .../public/Releases/Remove-GitHubRelease.ps1 | 2 +- .../public/Releases/Set-GitHubRelease.ps1 | 14 +++++------ .../public/Releases/Update-GitHubRelease.ps1 | 8 +++---- .../Get-GitHubRepositoryAutolink.ps1 | 4 ++-- .../New-GitHubRepositoryAutolink.ps1 | 2 +- .../Remove-GitHubRepositoryAutolink.ps1 | 2 +- .../Get-GitHubRepositoryCustomProperty.ps1 | 2 +- .../Repositories/Get-GitHubRepository.ps1 | 10 ++++---- .../Repositories/Move-GitHubRepository.ps1 | 2 +- .../Repositories/New-GitHubRepository.ps1 | 8 +++---- .../Get-GitHubRepositoryPermission.ps1 | 6 ++--- .../Remove-GitHubRepositoryPermission.ps1 | 2 +- .../Set-GitHubRepositoryPermission.ps1 | 2 +- .../Repositories/Remove-GitHubRepository.ps1 | 2 +- ...epositoryPrivateVulnerabilityReporting.ps1 | 2 +- .../Disable-GitHubRepositorySecurityFix.ps1 | 2 +- ...ble-GitHubRepositoryVulnerabilityAlert.ps1 | 2 +- ...epositoryPrivateVulnerabilityReporting.ps1 | 2 +- .../Enable-GitHubRepositorySecurityFix.ps1 | 2 +- ...ble-GitHubRepositoryVulnerabilityAlert.ps1 | 2 +- .../Get-GitHubRepositoryActivity.ps1 | 18 +++++++------- .../Get-GitHubRepositoryCodeownersError.ps1 | 2 +- .../Get-GitHubRepositoryContributor.ps1 | 2 +- .../Repositories/Get-GitHubRepositoryFork.ps1 | 2 +- .../Get-GitHubRepositoryLanguage.ps1 | 2 +- .../Get-GitHubRepositorySecurityFix.ps1 | 2 +- .../Repositories/Get-GitHubRepositoryTag.ps1 | 2 +- .../Repositories/Get-GitHubRepositoryTeam.ps1 | 2 +- .../Get-GitHubRepositoryTopic.ps1 | 2 +- .../Set-GitHubRepositoryTopic.ps1 | 2 +- .../Start-GitHubRepositoryEvent.ps1 | 2 +- ...est-GitHubRepositoryVulnerabilityAlert.ps1 | 2 +- .../Get-GitHubRepositoryRuleSuite.ps1 | 4 ++-- .../Repositories/Set-GitHubRepository.ps1 | 4 ++-- .../Repositories/Update-GitHubRepository.ps1 | 8 +++---- .../public/Secrets/Get-GitHubPublicKey.ps1 | 6 ++--- .../public/Secrets/Get-GitHubSecret.ps1 | 6 ++--- .../public/Secrets/Remove-GitHubSecret.ps1 | 6 ++--- .../Add-GitHubSecretSelectedRepository.ps1 | 2 +- .../Get-GitHubSecretSelectedRepository.ps1 | 4 ++-- .../Remove-GitHubSecretSelectedRepository.ps1 | 2 +- .../Set-GitHubSecretSelectedRepository.ps1 | 2 +- .../public/Secrets/Set-GitHubSecret.ps1 | 6 ++--- .../Status/Get-GitHubScheduledMaintenance.ps1 | 6 ++--- .../public/Status/Get-GitHubStatus.ps1 | 4 ++-- .../Status/Get-GitHubStatusComponent.ps1 | 2 +- .../Status/Get-GitHubStatusIncident.ps1 | 4 ++-- src/functions/public/Teams/Get-GitHubTeam.ps1 | 6 ++--- src/functions/public/Teams/New-GitHubTeam.ps1 | 2 +- .../public/Teams/Remove-GitHubTeam.ps1 | 2 +- .../public/Teams/Update-GitHubTeam.ps1 | 2 +- .../Users/Blocking/Block-GitHubUser.ps1 | 4 ++-- .../Users/Blocking/Get-GitHubBlockedUser.ps1 | 4 ++-- .../Users/Blocking/Test-GitHubBlockedUser.ps1 | 4 ++-- .../Users/Blocking/Unblock-GitHubUser.ps1 | 4 ++-- .../Users/Emails/Add-GitHubUserEmail.ps1 | 4 ++-- .../Users/Emails/Get-GitHubUserEmail.ps1 | 4 ++-- .../Users/Emails/Remove-GitHubUserEmail.ps1 | 4 ++-- .../Update-GitHubUserEmailVisibility.ps1 | 4 ++-- .../Followers/Add-GitHubUserFollowing.ps1 | 2 +- .../Followers/Get-GitHubUserFollower.ps1 | 4 ++-- .../Followers/Get-GitHubUserFollowing.ps1 | 4 ++-- .../Followers/Remove-GitHubUserFollowing.ps1 | 2 +- .../Followers/Test-GitHubUserFollowing.ps1 | 4 ++-- .../Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 | 2 +- .../Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 | 6 ++--- .../GPG-Keys/Remove-GitHubUserGpgKey.ps1 | 2 +- src/functions/public/Users/Get-GitHubUser.ps1 | 6 ++--- .../public/Users/Keys/Add-GitHubUserKey.ps1 | 2 +- .../public/Users/Keys/Get-GitHubUserKey.ps1 | 6 ++--- .../Users/Keys/Remove-GitHubUserKey.ps1 | 2 +- .../Add-GitHubUserSigningKey.ps1 | 2 +- .../Get-GitHubUserSigningKey.ps1 | 6 ++--- .../Remove-GitHubUserSigningKey.ps1 | 2 +- .../Social-Accounts/Add-GitHubUserSocial.ps1 | 4 ++-- .../Remove-GitHubUserSocial.ps1 | 4 ++-- .../public/Users/Update-GitHubUser.ps1 | 6 ++--- .../Variables/Export-GitHubVariable.ps1 | 2 +- .../public/Variables/Get-GitHubVariable.ps1 | 24 +++++++++---------- .../public/Variables/New-GitHubVariable.ps1 | 6 ++--- .../Variables/Remove-GitHubVariable.ps1 | 6 ++--- .../Add-GitHubVariableSelectedRepository.ps1 | 2 +- .../Get-GitHubVariableSelectedRepository.ps1 | 2 +- ...emove-GitHubVariableSelectedRepository.ps1 | 2 +- .../Set-GitHubVariableSelectedRepository.ps1 | 2 +- .../public/Variables/Set-GitHubVariable.ps1 | 6 ++--- .../Variables/Update-GitHubVariable.ps1 | 6 ++--- .../Get-GitHubAppWebhookConfiguration.ps1 | 2 +- .../Webhooks/Get-GitHubAppWebhookDelivery.ps1 | 4 ++-- .../Invoke-GitHubAppWebhookReDelivery.ps1 | 2 +- .../Webhooks/Test-GitHubWebhookSignature.ps1 | 8 +++---- .../Update-GitHubAppWebhookConfiguration.ps1 | 6 ++--- .../Workflows/Disable-GitHubWorkflow.ps1 | 2 +- .../Workflows/Enable-GitHubWorkflow.ps1 | 8 +++---- .../public/Workflows/Get-GitHubWorkflow.ps1 | 4 ++-- .../Workflows/Runs/Get-GitHubWorkflowRun.ps1 | 8 +++---- .../Runs/Remove-GitHubWorkflowRun.ps1 | 2 +- .../Runs/Restart-GitHubWorkflowRun.ps1 | 2 +- .../Workflows/Runs/Stop-GitHubWorkflowRun.ps1 | 2 +- .../public/Workflows/Start-GitHubWorkflow.ps1 | 2 +- tools/utilities/New-Function.ps1 | 2 +- tools/utilities/New-FunctionTemplate.ps1 | 2 +- 319 files changed, 568 insertions(+), 568 deletions(-) diff --git a/src/functions/private/Actions/Import-GitHubEventData.ps1 b/src/functions/private/Actions/Import-GitHubEventData.ps1 index 50b01bf36..1446dd01a 100644 --- a/src/functions/private/Actions/Import-GitHubEventData.ps1 +++ b/src/functions/private/Actions/Import-GitHubEventData.ps1 @@ -9,7 +9,7 @@ function Import-GitHubEventData { Import data from the event that triggered the workflow. .EXAMPLE - ```pwsh + ```powershell Import-GitHubEventData ``` #> diff --git a/src/functions/private/Actions/Import-GitHubRunnerData.ps1 b/src/functions/private/Actions/Import-GitHubRunnerData.ps1 index 33d964e95..527860aad 100644 --- a/src/functions/private/Actions/Import-GitHubRunnerData.ps1 +++ b/src/functions/private/Actions/Import-GitHubRunnerData.ps1 @@ -7,7 +7,7 @@ function Import-GitHubRunnerData { Import data about the runner that is running the workflow. .EXAMPLE - ```pwsh + ```powershell Import-GitHubRunnerData ``` #> diff --git a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 index b2c832831..0d7b4e347 100644 --- a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 +++ b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 @@ -12,14 +12,14 @@ filter Get-GitHubWorkflowRunByRepo { `created`, `event`, `head_sha`, `status`. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRunByRepo -Owner 'owner' -Repository 'repo' ``` Lists all workflow runs for a repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRunByRepo -Owner 'owner' -Repository 'repo' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' ``` diff --git a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 index c008037a4..6199f1a1b 100644 --- a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 +++ b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 @@ -13,14 +13,14 @@ filter Get-GitHubWorkflowRunByWorkflow { `created`, `event`, `head_sha`, `status`. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRunByWorkflow -Owner 'octocat' -Repository 'Hello-World' -ID '42' ``` Gets all workflow runs for the workflow with the ID `42` in the repository `Hello-World` owned by `octocat`. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRunByWorkflow -Owner 'octocat' -Repository 'Hello-World' -ID '42' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 index f5e5dd195..be4def9bf 100644 --- a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 @@ -9,7 +9,7 @@ function Uninstall-GitHubAppOnEnterpriseOrganization { The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (write) permission. .EXAMPLE - ```pwsh + ```powershell Uninstall-GitHubAppOnEnterpriseOrganization -Enterprise 'github' -Organization 'octokit' -ID '123456' ``` diff --git a/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 b/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 index 65d181e4b..bb4f6a217 100644 --- a/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 @@ -8,21 +8,21 @@ function Update-GitHubAppJWT { it will be refreshed. This function implements mutex-based locking to prevent concurrent refreshes. .EXAMPLE - ```pwsh + ```powershell Update-GitHubAppJWT -Context $Context ``` Updates the JSON Web Token (JWT) for a GitHub App using the specified context. .EXAMPLE - ```pwsh + ```powershell Update-GitHubAppJWT -Context $Context -PassThru ``` This will update the GitHub App JWT for the specified context and return the updated context. .EXAMPLE - ```pwsh + ```powershell Update-GitHubAppJWT -Context $Context -Silent ``` diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 index eed955e78..ad215d786 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 @@ -9,12 +9,12 @@ function Get-GitHubArtifactById { The function returns a custom GitHubArtifact object containing metadata and download information for the artifact. .EXAMPLE - ```pwsh + ```powershell Get-GitHubArtifactById -Owner 'octocat' -Repository 'hello-world' -ID '123456' ``` Output: - ```pwsh + ```powershell Name : build-artifact ID : 123456 Url : https://api.github.com/repos/octocat/hello-world/actions/artifacts/123456 diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 index 9efeaeb56..7880838a7 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 @@ -10,12 +10,12 @@ function Get-GitHubArtifactFromRepository { By default, only the latest version of each artifact is returned unless -AllVersions is specified. .EXAMPLE - ```pwsh + ```powershell Get-GitHubArtifactFromRepository -Owner 'octocat' -Repository 'demo-repo' -AllVersions ``` Output: - ```pwsh + ```powershell Name : build-output ID : 4567890 Expired : False diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 index 79ec4161e..4120b0940 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 @@ -9,12 +9,12 @@ function Get-GitHubArtifactFromWorkflowRun { The function can optionally filter artifacts by name or return only the latest version per artifact name. .EXAMPLE - ```pwsh + ```powershell Get-GitHubArtifactFromWorkflowRun -Owner 'octocat' -Repository 'demo' -ID '123456789' ``` Output: - ```pwsh + ```powershell ID : 10 NodeID : MDEwOkFydGlmYWN0MQ== Name : build-logs diff --git a/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 b/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 index 4824841ef..61b2d7b7a 100644 --- a/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 +++ b/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 @@ -9,13 +9,13 @@ filter Connect-GitHubCli { If authentication fails, a warning is displayed, and `LASTEXITCODE` is reset to `0`. .EXAMPLE - ```pwsh + ```powershell $context = Connect-GitHubAccount $context | Connect-GitHubCli ``` Output: - ```pwsh + ```powershell (No output unless an error occurs) ``` diff --git a/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 b/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 index b6ecd0d75..4d1b03bce 100644 --- a/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 @@ -8,7 +8,7 @@ filter Assert-GitHubContext { If the context does not meet the requirements, an error is thrown. .EXAMPLE - ```pwsh + ```powershell Assert-GitHubContext -Context 'github.com/Octocat' -AuthType 'App' ``` #> diff --git a/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 b/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 index 9364c5710..d8461ccc9 100644 --- a/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 @@ -9,14 +9,14 @@ filter Remove-GitHubContext { If the specified context(s) exist, they will be removed from the vault. .EXAMPLE - ```pwsh + ```powershell Remove-Context ``` Removes all contexts from the vault. .EXAMPLE - ```pwsh + ```powershell Remove-Context -ID 'MyContext' ``` diff --git a/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 b/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 index 67bdb4380..93450a4c3 100644 --- a/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 @@ -11,14 +11,14 @@ filter Resolve-GitHubContext { If the context is a App, it will look at the available contexts and return the one that matches the scope of the command being run. .EXAMPLE - ```pwsh + ```powershell $Context = Resolve-GitHubContext -Context 'github.com/Octocat' ``` This will resolve the context 'github.com/Octocat' into a GitHubContext object. .EXAMPLE - ```pwsh + ```powershell $Context = Resolve-GitHubContext -Context $GitHubContext ``` diff --git a/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 b/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 index 94332fb6a..4cdbcd3dc 100644 --- a/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 +++ b/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 @@ -9,36 +9,36 @@ function Resolve-GitHubContextSetting { it will return the default value from the GitHub configuration. This is useful for resolving API-related settings dynamically. .EXAMPLE - ```pwsh + ```powershell Resolve-GitHubContextSetting -Name 'Repository' -Value 'MyRepo' ``` Output: - ```pwsh + ```powershell MyRepo ``` Returns the provided value 'MyRepo' for the 'Repository' setting. .EXAMPLE - ```pwsh + ```powershell Resolve-GitHubContextSetting -Name 'Repository' -Context $GitHubContext ``` Output: - ```pwsh + ```powershell MyRepository ``` Retrieves the 'Repository' setting from the provided GitHub context object. .EXAMPLE - ```pwsh + ```powershell Resolve-GitHubContextSetting -Name 'ApiBaseUrl' ``` Output: - ```pwsh + ```powershell https://api.github.com ``` diff --git a/src/functions/private/Auth/Context/Set-GitHubContext.ps1 b/src/functions/private/Auth/Context/Set-GitHubContext.ps1 index a98d75461..c25684b2e 100644 --- a/src/functions/private/Auth/Context/Set-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Set-GitHubContext.ps1 @@ -8,7 +8,7 @@ function Set-GitHubContext { The context is used to authenticate with the GitHub API. .EXAMPLE - ```pwsh + ```powershell $context = @{ ApiBaseUri = 'https://api.github.com' ApiVersion = '2022-11-28' diff --git a/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 b/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 index a181dbf02..71f3565a6 100644 --- a/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 @@ -7,7 +7,7 @@ function Invoke-GitHubDeviceFlowLogin { Starts the GitHub Device Flow login process. This will prompt the user to visit a URL and enter a code. .EXAMPLE - ```pwsh + ```powershell Invoke-GitHubDeviceFlowLogin ``` diff --git a/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 index 2e35b62b2..eed8e60b7 100644 --- a/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 @@ -8,7 +8,7 @@ function Request-GitHubAccessToken { This will poll the GitHub API until the user has entered the code. .EXAMPLE - ```pwsh + ```powershell Request-GitHubAccessToken -DeviceCode $deviceCode -ClientID $ClientID -HostName 'github.com' ``` diff --git a/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 b/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 index 59b170e59..79c9481a6 100644 --- a/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 @@ -7,7 +7,7 @@ function Request-GitHubDeviceCode { Request a GitHub Device Code. .EXAMPLE - ```pwsh + ```powershell Request-GitHubDeviceCode -ClientID $ClientID -Mode $Mode -HostName 'github.com' ``` diff --git a/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 b/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 index b7c6f9f92..423b1b2cd 100644 --- a/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 @@ -7,7 +7,7 @@ function Test-GitHubAccessTokenRefreshRequired { Test if the GitHub access token should be refreshed. .EXAMPLE - ```pwsh + ```powershell Test-GitHubAccessTokenRefreshRequired ``` diff --git a/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 index 961c27e18..c20fa4635 100644 --- a/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 @@ -7,14 +7,14 @@ function Update-GitHubUserAccessToken { Updates the GitHub access token. If the access token is still valid, it will not be refreshed. .EXAMPLE - ```pwsh + ```powershell Update-GitHubUserAccessToken ``` This will update the GitHub access token for the default context. .EXAMPLE - ```pwsh + ```powershell Update-GitHubUserAccessToken -Context 'github.com/mojombo' ``` diff --git a/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 index 9bca3d29f..a9c3794d4 100644 --- a/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 @@ -8,14 +8,14 @@ function Wait-GitHubAccessToken { This will poll the GitHub API until the user has entered the code. .EXAMPLE - ```pwsh + ```powershell Wait-GitHubAccessToken -DeviceCode $deviceCode -ClientID $ClientID -Interval $interval ``` This will poll the GitHub API until the user has entered the code. .EXAMPLE - ```pwsh + ```powershell Wait-GitHubAccessToken -Refresh -ClientID $ClientID ``` diff --git a/src/functions/private/Auth/Get-GitHubToken.ps1 b/src/functions/private/Auth/Get-GitHubToken.ps1 index 5cb94e170..d472bff8c 100644 --- a/src/functions/private/Auth/Get-GitHubToken.ps1 +++ b/src/functions/private/Auth/Get-GitHubToken.ps1 @@ -10,24 +10,24 @@ function Get-GitHubToken { either a raw token value or a secure version for sensitive operations. .EXAMPLE - ```pwsh + ```powershell Get-GitHubToken ``` Output: - ```pwsh + ```powershell System.Security.SecureString ``` Returns the GitHub token as a secure string for safer handling in scripts or automation. .EXAMPLE - ```pwsh + ```powershell Get-GitHubToken -AsPlainText ``` Output: - ```pwsh + ```powershell ghp_XXXXXXXXXXXXXXXXXXXXXX ``` diff --git a/src/functions/private/Auth/Test-GitHubToken.ps1 b/src/functions/private/Auth/Test-GitHubToken.ps1 index 733b6b4fb..75cabe3c5 100644 --- a/src/functions/private/Auth/Test-GitHubToken.ps1 +++ b/src/functions/private/Auth/Test-GitHubToken.ps1 @@ -7,7 +7,7 @@ function Test-GitHubToken { This function checks if the GitHub token is available in the environment variables. .EXAMPLE - ```pwsh + ```powershell Test-GitHubToken ``` #> diff --git a/src/functions/private/Branches/Get-GitHubBranchList.ps1 b/src/functions/private/Branches/Get-GitHubBranchList.ps1 index 4dba98c02..048225ce1 100644 --- a/src/functions/private/Branches/Get-GitHubBranchList.ps1 +++ b/src/functions/private/Branches/Get-GitHubBranchList.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubBranchList { Lists all branches from a repository .EXAMPLE - ```pwsh + ```powershell Get-GitHubBranchList -Owner 'octocat' -Repository 'Hello-World' ``` diff --git a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 index 21eaa84c2..9792c3ae0 100644 --- a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 +++ b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 @@ -8,7 +8,7 @@ filter ConvertFrom-GitHubOutput { supporting both single-line and multi-line values, and parsing JSON values. .EXAMPLE - ```pwsh + ```powershell $content = @' zen=something else result={"MyOutput":"Hello, World!","Status":"Success"} diff --git a/src/functions/private/Config/Initialize-GitHubConfig.ps1 b/src/functions/private/Config/Initialize-GitHubConfig.ps1 index 289b6c721..b51d3da52 100644 --- a/src/functions/private/Config/Initialize-GitHubConfig.ps1 +++ b/src/functions/private/Config/Initialize-GitHubConfig.ps1 @@ -7,14 +7,14 @@ function Initialize-GitHubConfig { Initialize the GitHub module configuration. .EXAMPLE - ```pwsh + ```powershell Initialize-GitHubConfig ``` Initializes the GitHub module configuration. .EXAMPLE - ```pwsh + ```powershell Initialize-GitHubConfig -Force ``` diff --git a/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 b/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 index 3bc26df57..7c1b52749 100644 --- a/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 +++ b/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 @@ -10,7 +10,7 @@ function ConvertTo-GitHubGraphQLField { Properties not found in the mapping table are skipped with a warning. .EXAMPLE - ```pwsh + ```powershell $fields = ConvertTo-GitHubGraphQLField -Property @('Name','Owner') -AdditionalProperty 'Url' -PropertyToGraphQLMap $map Returns the GraphQL fields for Name, Owner, and Url. ``` diff --git a/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 b/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 index 569c9a53c..b1e75b910 100644 --- a/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 +++ b/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 @@ -9,12 +9,12 @@ function Get-GitHubEnterpriseByName { information. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnterpriseByName -Name 'my-enterprise' ``` Output: - ```pwsh + ```powershell Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise diff --git a/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 b/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 index b28d016e6..73840555b 100644 --- a/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 +++ b/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 @@ -8,12 +8,12 @@ function Get-GitHubEnterpriseList { creation dates, and other metadata. It returns an array of objects of type GitHubEnterprise populated with this information. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnterpriseList ``` Output: - ```pwsh + ```powershell Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise diff --git a/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 b/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 index 73f94ce8a..8be956e67 100644 --- a/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 +++ b/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 @@ -13,12 +13,12 @@ filter Get-GitHubEnvironmentByName { to use this function with a private repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnvironment -Owner 'PSModule' -Repository 'EnvironmentTest' -Name 'test' ``` Output: - ```pwsh + ```powershell id : 5944178128 node_id : EN_kwDOOJqfM88AAAABYkz10A name : test diff --git a/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 b/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 index 3cb7a2764..7d9dce21f 100644 --- a/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 +++ b/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 @@ -10,12 +10,12 @@ filter Get-GitHubEnvironmentList { to use this endpoint with a private repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnvironmentList -Owner 'PSModule' -Repository 'EnvironmentTest' ``` Output: - ```pwsh + ```powershell id : 5944178128 node_id : EN_kwDOOJqfM88AAAABYkz10A name : test diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 index 3c2f06992..23a339c41 100644 --- a/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 +++ b/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubGitignoreByName { Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. .EXAMPLE - ```pwsh + ```powershell Get-GitHubGitignoreList ``` diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 index 3c3902d55..596181d97 100644 --- a/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 +++ b/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubGitignoreList { [creating a repository](https://docs.github.com/rest/repos/repos#create-a-repository-for-the-authenticated-user). .EXAMPLE - ```pwsh + ```powershell Get-GitHubGitignoreList ``` diff --git a/src/functions/private/License/Get-GitHubLicenseByName.ps1 b/src/functions/private/License/Get-GitHubLicenseByName.ps1 index 25bdb5443..e60977b70 100644 --- a/src/functions/private/License/Get-GitHubLicenseByName.ps1 +++ b/src/functions/private/License/Get-GitHubLicenseByName.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubLicenseByName { For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubGitignoreList ``` diff --git a/src/functions/private/License/Get-GitHubLicenseList.ps1 b/src/functions/private/License/Get-GitHubLicenseList.ps1 index 6702af06f..af8b3429e 100644 --- a/src/functions/private/License/Get-GitHubLicenseList.ps1 +++ b/src/functions/private/License/Get-GitHubLicenseList.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubLicenseList { For more information, see "[Licensing a repository ](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubLicenseList ``` diff --git a/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 b/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 index d69a7c588..f641d91ce 100644 --- a/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 +++ b/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 @@ -10,7 +10,7 @@ filter Get-GitHubRepositoryLicense { [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryLicense -Owner 'octocat' -Repository 'Hello-World' ``` diff --git a/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 index cc5869616..90d690f06 100644 --- a/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 @@ -8,7 +8,7 @@ filter Block-GitHubUserByOrganization { If the organization cannot block the given user a 422 is returned. .EXAMPLE - ```pwsh + ```powershell Block-GitHubUserByOrganization -Organization 'github' -Username 'octocat' ``` diff --git a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 index 5fcb763f3..0eb5d211a 100644 --- a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubBlockedUserByOrganization { List the users blocked by an organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubBlockedUserByOrganization -Organization 'github' ``` diff --git a/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 index 5d0d83f2c..9eebeafd0 100644 --- a/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 @@ -8,7 +8,7 @@ filter Test-GitHubBlockedUserByOrganization { Returns a 404 if the organization is not blocking the user, or if the user account has been identified as spam by GitHub. .EXAMPLE - ```pwsh + ```powershell Test-GitHubBlockedUserByOrganization -Organization 'PSModule' -Username 'octocat' ``` diff --git a/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 index 6f036e3b4..2af822011 100644 --- a/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 @@ -7,7 +7,7 @@ filter Unblock-GitHubUserByOrganization { Unblocks the given user on behalf of the specified organization. .EXAMPLE - ```pwsh + ```powershell Unblock-GitHubUserByOrganization -Organization 'github' -Username 'octocat' ``` diff --git a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 index 1ed6b85aa..2d871fc07 100644 --- a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 +++ b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 @@ -10,7 +10,7 @@ filter Get-GitHubAllOrganization { Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAllOrganization -Since 142951047 ``` diff --git a/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 b/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 index c32be3103..f06ac7002 100644 --- a/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 +++ b/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 @@ -15,7 +15,7 @@ filter Get-GitHubOrganizationByName { for details. For an example response, see 'Response with GitHub plan information' below." .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganizationByName -Name 'github' ``` diff --git a/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 b/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 index fa10956fa..577d91f49 100644 --- a/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 +++ b/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 @@ -8,12 +8,12 @@ function Get-GitHubOrganizationListForAuthUser { creation dates, member counts, and other metadata. It returns an array of objects of type GitHubOrganization populated with this information. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganizationListForAuthUser ``` Output: - ```pwsh + ```powershell Name : MyOrganization Login : my-org URL : https://github.com/my-org diff --git a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 index 5492d2bb2..800d45cc2 100644 --- a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 +++ b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 @@ -13,7 +13,7 @@ filter Get-GitHubUserOrganization { API instead. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserOrganization -Username 'octocat' ``` diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 index 273cdd672..81c1abc12 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 @@ -10,7 +10,7 @@ filter Get-GitHubReleaseAssetByID { possible. API clients should handle both a `200` or `302` response. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAssetByID -Owner 'octocat' -Repository 'hello-world' -ID '1234567' ``` diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 index ff54e1b52..37ecb294b 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 @@ -7,14 +7,14 @@ filter Get-GitHubReleaseAssetByReleaseID { List release assets .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAssetByReleaseID -Owner 'octocat' -Repository 'hello-world' -ID '1234567' ``` Gets the release assets for the release with the ID '1234567' for the repository 'octocat/hello-world'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAssetByReleaseID -Owner 'octocat' -Repository 'hello-world' -ID '1234567' -Name 'example.zip' ``` diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 index 454ddd95d..9724a7a65 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 @@ -8,14 +8,14 @@ filter Get-GitHubReleaseAssetByTag { Uses pagination to retrieve all assets even if there are more than the maximum per page. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAssetByTag -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' ``` Gets all release assets for the release with the tag 'v1.0.0' for the repository 'octocat/hello-world'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAssetByTag -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Name 'app.zip' ``` diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 index dfe73f22c..0d4ffc548 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 @@ -9,14 +9,14 @@ filter Get-GitHubReleaseAssetFromLatest { The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAssetFromLatest -Owner 'octocat' -Repository 'hello-world' ``` Gets the assets for the latest release of the repository 'hello-world' owned by 'octocat'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAssetFromLatest -Owner 'octocat' -Repository 'hello-world' -Name 'asset-name' ``` diff --git a/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 b/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 index 56b583bb7..7782b1d3d 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubReleaseAll { Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAll -Owner 'octocat' -Repository 'hello-world' ``` diff --git a/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 b/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 index c3ce3eae7..803e793c2 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubReleaseByID { This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseById -Owner 'octocat' -Repository 'hello-world' -ID '1234567' ``` diff --git a/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 b/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 index b7fcece3a..bcf521e7d 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubReleaseByTagName { Get a published release with the specified tag. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseByTagName -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' ``` diff --git a/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 b/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 index 84cedbcc0..b682b45bd 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubReleaseLatest { The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseLatest -Owner 'octocat' -Repository 'hello-world' ``` diff --git a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 index ac222bec8..8244f780f 100644 --- a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 +++ b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubRepositoryAutolinkById { Information about autolinks are only available to repository administrators. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryAutolinkById -Owner 'octocat' -Repository 'Hello-World' -ID 1 ``` diff --git a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 index 7d349cb42..f54c23850 100644 --- a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 +++ b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubRepositoryAutolinkList { Information about autolinks are only available to repository administrators. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryAutolinkList -Owner 'octocat' -Repository 'Hello-World' ``` diff --git a/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 b/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 index 12cc474a2..49235678d 100644 --- a/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 +++ b/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 @@ -9,14 +9,14 @@ filter Get-GitHubMyRepositories { they are a collaborator, and repositories that they can access through an organization membership. .EXAMPLE - ```pwsh + ```powershell Get-GitHubMyRepositories ``` Gets the repositories for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubMyRepositories -Visibility 'private' ``` diff --git a/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 b/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 index dcd9ba4fa..4cf580d02 100644 --- a/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 +++ b/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubMyRepositoryByName { they are a collaborator, and repositories that they can access through an organization membership. .EXAMPLE - ```pwsh + ```powershell Get-GitHubMyRepositoryByName ``` diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 index 2e5c8689c..006c74328 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 @@ -11,7 +11,7 @@ filter Get-GitHubRepositoryByName { For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryByName -Owner 'octocat' -Name 'Hello-World' ``` diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 index d04154104..c957fc458 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 @@ -7,12 +7,12 @@ filter Get-GitHubRepositoryByNameAndTeam { Retrieves the permission level assigned to a specific team for a given GitHub repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryByNameAndTeam -Owner 'octocat' -Name 'Hello-World' -Team 'core' ``` Output: - ```pwsh + ```powershell ``` diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 index 14dce1547..007e3600d 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 @@ -8,21 +8,21 @@ filter Get-GitHubRepositoryListByOwner { Note: For GitHub AE, this endpoint will list internal repositories for the specified user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryListByOwner -Owner 'octocat' ``` Gets the repositories for the user 'octocat'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryListByOwner -Owner 'octocat' -Type 'member' ``` Gets the repositories of organizations where the user 'octocat' is a member. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryListByOwner -Owner 'octocat' -Sort 'created' -Direction 'asc' ``` diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 index b20c808e7..430c732e4 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 @@ -7,12 +7,12 @@ filter Get-GitHubRepositoryListByTeam { Lists a team's repositories visible to the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryListByTeam -Owner 'octocat' -Team 'core' ``` Output: - ```pwsh + ```powershell ``` Lists all repositories that the 'core' team has access to in the organization owned by 'octocat'. diff --git a/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 index 1e0be15ee..56d0fe43e 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 @@ -13,7 +13,7 @@ filter New-GitHubRepositoryAsFork { repositories and on the source account with access to the source repository. .EXAMPLE - ```pwsh + ```powershell New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' ``` @@ -21,21 +21,21 @@ filter New-GitHubRepositoryAsFork { Repo will be named `Hello-World`, and all branches and tags will be forked. .EXAMPLE - ```pwsh + ```powershell New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' -Name 'Hello-World-2' ``` Fork the repository `Hello-World` owned by `github` for the authenticated user, naming the resulting repository `Hello-World-2`. .EXAMPLE - ```pwsh + ```powershell New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' -Owner 'octocat' ``` Fork the repository `Hello-World` owned by `github` for the organization `octocat`, naming the resulting repository `Hello-World`. .EXAMPLE - ```pwsh + ```powershell New-GitHubRepositoryAsFork -ForkOwner 'github' -ForkRepository 'Hello-World' -IncludeAllBranches ``` diff --git a/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 index ce482be2e..6b6adc416 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 @@ -18,7 +18,7 @@ filter New-GitHubRepositoryFromTemplate { * `repo` scope to create a private repository .EXAMPLE - ```pwsh + ```powershell $params = @{ TemplateOwner = 'GitHub' TemplateRepository = 'octocat' diff --git a/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 index 16a9b2a42..a1981d72e 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 @@ -14,7 +14,7 @@ filter New-GitHubRepositoryOrg { * `repo` scope to create a private repository .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'PSModule' Name = 'Hello-World' diff --git a/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 index bca83407a..cfb86eb3e 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 @@ -14,7 +14,7 @@ filter New-GitHubRepositoryUser { * `repo` scope to create a private repository. .EXAMPLE - ```pwsh + ```powershell $params = @{ Name = 'Hello-World' Description = 'This is your first repository' diff --git a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 index 84c4f78ab..3a9a1f8c6 100644 --- a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 +++ b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubRepositoryRuleSuiteById { For more information, see "[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryRuleSuiteById -Owner 'octocat' -Repository 'hello-world' -RuleSuiteId 123456789 ``` diff --git a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 index 67493c4e6..7d1311f3d 100644 --- a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 +++ b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubRepositoryRuleSuiteList { For more information, see"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repo = 'hello-world' diff --git a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 index 65d25ad36..cdc2f9e7f 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 @@ -8,12 +8,12 @@ function Get-GitHubSecretEnvironmentByName { create, update, or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretEnvironmentByName -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'SECRET1' -Context $GitHubContext ``` Output: - ```pwsh + ```powershell Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 index f84dd8bff..af2c588a1 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 @@ -9,12 +9,12 @@ function Get-GitHubSecretEnvironmentList { endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretEnvironmentList -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Context $GitHubContext ``` Output: - ```pwsh + ```powershell Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 b/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 index 7f46446a7..34bc739df 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 @@ -9,12 +9,12 @@ function Get-GitHubSecretFromOrganization { this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretFromOrganization -Owner 'octocat' -Repository 'helloworld' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : SECRET1 Owner : octocat Repository : diff --git a/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 index 62a404112..c1bb7ae08 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 @@ -12,12 +12,12 @@ function Get-GitHubSecretOwnerByName { the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretOwnerByName -Owner 'octocat' -Name 'SECRET_THING' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : SECRET_THING Owner : octocat Repository : diff --git a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 index ec3567c82..e8d6928b6 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 @@ -9,12 +9,12 @@ function Get-GitHubSecretOwnerList { endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretOwnerList -Owner 'PSModule' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell ``` Retrieves all secrets from the specified organization. diff --git a/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 index a322acf90..1d20738c9 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 @@ -8,12 +8,12 @@ function Get-GitHubSecretRepositoryByName { to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretRepositoryByName -Owner 'octocat' -Repository 'Hello-World' -Name 'SECRET1' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 index 4f32140ff..49a40c2d8 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 @@ -9,12 +9,12 @@ function Get-GitHubSecretRepositoryList { endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretRepositoryList -Owner 'octocat' -Repository 'Hello-World' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : SECRET1 Owner : octocat Repository : Hello-World diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 index 573011641..318088cd8 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 @@ -9,12 +9,12 @@ function Get-GitHubPublicKeyForActionOnEnvironment { access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKeyForActionOnEnvironment -Owner 'octocat' -Repository 'hello-world' -Environment 'prod' -Context $GitHubContext ``` Outputs: - ```pwsh + ```powershell ID : 3380204578043523366 Key : ypK8XbFOtcXsCaqJOfdWjpCNumPmF3sfAbbv7x+3uSE= #gitleaks:allow Type : actions diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 index 4824a61ad..7b008a5b2 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 @@ -10,12 +10,12 @@ function Get-GitHubPublicKeyForActionOnOrganization { need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKeyForActionOnOrganization -Owner 'octocat' -Context $GitHubContext ``` Outputs: - ```pwsh + ```powershell ID : 3380204578043523366 Key : hwzclrjNNtZxYby19+0fiG7LazGFZxaM1IEbB25fkwo= #gitleaks:allow Type : actions diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 index 8704a9384..e29aeed80 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 @@ -9,12 +9,12 @@ function Get-GitHubPublicKeyForActionOnRepository { the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKeyForActionOnRepository -Owner 'octocat' -Repository 'hello-world' -Context $GitHubContext ``` Outputs: - ```pwsh + ```powershell ID : 3380204578043523366 Key : WkwZZ0xWbxZMqWrfUxLgvnALbrfdZSWxrhBcfTKshDY= #gitleaks:allow Type : actions diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 index e883596dd..cae97852f 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 @@ -8,12 +8,12 @@ function Get-GitHubPublicKeyForCodespacesOnOrganization { can create or update secrets. OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKeyForCodespacesOnOrganization -Owner 'octocat' -Context $GitHubContext ``` Outputs: - ```pwsh + ```powershell ID : 3380189982652154440 Key : XbfD9j2CNq6L2qq2xpYrRhRRdFgR0CzfISQqsAIInGE= #gitleaks:allow Type : codespaces diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 index 1d5b5344a..9cfa87f39 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 @@ -8,12 +8,12 @@ function Get-GitHubPublicKeyForCodespacesOnRepository { repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKeyForCodespacesOnRepository -Owner 'octocat' -Repository 'hello-world' -Context $GitHubContext ``` Outputs: - ```pwsh + ```powershell ID : 3380189982652154440 Key : xPliIrAsVlPub63sB1cnvx/CKt5FGb5rjlbF7uHC+hM= #gitleaks:allow Type : codespaces diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 index 4fa847e5c..95b8595ff 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 @@ -9,12 +9,12 @@ function Get-GitHubPublicKeyForCodespacesOnUser { OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKeyForCodespacesOnUser -Context $GitHubContext ``` Outputs: - ```pwsh + ```powershell ID : 3380189982652154440 Key : dpr7ea5wmASt3ewAYNR/wPiPd6qakxN0060jdBmun0Y= #gitleaks:allow Type : codespaces diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 index 22da5abec..1f646e608 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 @@ -8,7 +8,7 @@ function Remove-GitHubSecretFromEnvironment { or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubSecretFromEnvironment -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'SECRET1' -Context $GitHubContext ``` diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 index d21e4e924..6dbf4d7f1 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 @@ -9,7 +9,7 @@ function Remove-GitHubSecretFromOwner { is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubSecretFromOwner -Owner 'octocat' -Name 'HOST_NAME' -Context $GitHubContext ``` diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 index 46913ee03..c19b49a1f 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 @@ -8,7 +8,7 @@ function Remove-GitHubSecretFromRepository { or read secrets. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubSecretFromRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'SECRET1' -Context $GitHubContext ``` diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 index 7db7603aa..8c25cfcc2 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 @@ -11,7 +11,7 @@ function Set-GitHubSecretOnEnvironment { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repository = 'Hello-World' diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 index c4cd3893c..a1d17bf9c 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 @@ -12,7 +12,7 @@ function Set-GitHubSecretOnOwner { the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Set-GitHubSecretOnOwner -Owner 'octocat' -Name 'HOST_NAME' -Value 'test_value' -Context $GitHubContext ``` diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 index 237b04d1c..4a7212926 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 @@ -11,7 +11,7 @@ function Set-GitHubSecretOnRepository { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Set-GitHubSecretOnRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'SECRET1' -Value 'SECRET_VALUE' -Context $GitHubContext ``` diff --git a/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 b/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 index e2c69ef1f..a9d65c6ad 100644 --- a/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 @@ -8,7 +8,7 @@ function Get-GitHubTeamBySlug { and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name. .EXAMPLE - ```pwsh + ```powershell Get-GitHubTeamBySlug -Organization 'github' -Slug 'my-team-name' ``` diff --git a/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 b/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 index 759aa73ca..af1473d3f 100644 --- a/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 @@ -7,7 +7,7 @@ function Get-GitHubTeamListByOrg { Lists all teams in an organization that are visible to the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubTeamListByOrg -Organization 'github' ``` diff --git a/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 b/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 index 401b0c3ca..c24f3d32c 100644 --- a/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 @@ -10,12 +10,12 @@ filter Get-GitHubTeamListByRepo { and repo scope to use this endpoint with a private repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubTeamListByRepo -Owner 'octocat' -Repository 'Hello-World' ``` Output: - ```pwsh + ```powershell ``` diff --git a/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 b/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 index c38ddaf00..8be9ff3c5 100644 --- a/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 @@ -7,7 +7,7 @@ filter Block-GitHubUserByUser { Blocks the given user and returns a 204. If the authenticated user cannot block the given user a 422 is returned. .EXAMPLE - ```pwsh + ```powershell Block-GitHubUserByUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 index f429e51ff..17220ec67 100644 --- a/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubBlockedUserByUser { List the users you've blocked on your personal account. .EXAMPLE - ```pwsh + ```powershell Get-GitHubBlockedUserByUser ``` diff --git a/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 index 084a15a49..095d3e64a 100644 --- a/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 @@ -9,7 +9,7 @@ filter Test-GitHubBlockedUserByUser { or if the given user account has been identified as spam by GitHub. .EXAMPLE - ```pwsh + ```powershell Test-GitHubBlockedUserByUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 b/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 index fa912aac0..5cbf1ceed 100644 --- a/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 @@ -7,7 +7,7 @@ filter Unblock-GitHubUserByUser { Unblocks the given user and returns a 204. .EXAMPLE - ```pwsh + ```powershell Unblock-GitHubUserByUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 index fd17873d6..d943ae302 100644 --- a/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 +++ b/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubUserAllEmail { This endpoint is accessible with the `user:email` scope. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserAllEmail ``` diff --git a/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 index 8f7dcb188..5d2ae28d2 100644 --- a/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 +++ b/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubUserPublicEmail { endpoint. This endpoint is accessible with the `user:email` scope. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserPublicEmail ``` diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 index b82281d53..b26cabf04 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserFollowersOfUser { Lists the people following the specified user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserFollowersOfUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 index 583a846f5..8ed61efab 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserFollowingMe { Lists the people who the authenticated user follows. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserFollowingMe ``` diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 index 34bb0e657..c87264270 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserFollowingUser { Lists the people who the specified user follows. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserFollowingUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 index aa007cb54..97b82b16c 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserMyFollower { Lists the people following the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserMyFollowers ``` diff --git a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 index c0a7e68d0..3a1a82efe 100644 --- a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 +++ b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 @@ -8,7 +8,7 @@ filter Test-GitHubUserFollowedByMe { Returns a 404 if the user is not followed by the authenticated user. .EXAMPLE - ```pwsh + ```powershell Test-GitHubUserFollowedByMe -Username 'octocat' ``` diff --git a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 index 11b1db3b3..ffd3ad967 100644 --- a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 +++ b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 @@ -7,7 +7,7 @@ filter Test-GitHubUserFollowedByUser { Checks if a user follows another user. .EXAMPLE - ```pwsh + ```powershell Test-GitHubUserFollowedByUser -Username 'octocat' -Follows 'ratstallion' ``` diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 index 758a57564..020099515 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserGpgKeyForUser { Lists the GPG keys for a user. This information is accessible by anyone. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserGpgKeyForUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 index 92cba58f9..87eaa5cf5 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubUserMyGpgKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserMyGpgKey ``` diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 index 6e31a96bd..90b7efaee 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubUserMyGpgKeyById { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserMyGpgKeyById -ID '1234567' ``` diff --git a/src/functions/private/Users/Get-GitHubAllUser.ps1 b/src/functions/private/Users/Get-GitHubAllUser.ps1 index 7faa4f3c9..3e1fc9f34 100644 --- a/src/functions/private/Users/Get-GitHubAllUser.ps1 +++ b/src/functions/private/Users/Get-GitHubAllUser.ps1 @@ -11,7 +11,7 @@ filter Get-GitHubAllUser { to get the URL for the next page of users. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAllUser -Since 17722253 ``` diff --git a/src/functions/private/Users/Get-GitHubMyUser.ps1 b/src/functions/private/Users/Get-GitHubMyUser.ps1 index c5e01c6c7..e9fcb2e57 100644 --- a/src/functions/private/Users/Get-GitHubMyUser.ps1 +++ b/src/functions/private/Users/Get-GitHubMyUser.ps1 @@ -10,7 +10,7 @@ filter Get-GitHubMyUser { profile information. .EXAMPLE - ```pwsh + ```powershell Get-GitHubMyUser ``` diff --git a/src/functions/private/Users/Get-GitHubUserByName.ps1 b/src/functions/private/Users/Get-GitHubUserByName.ps1 index 4fd226c95..61a63ec83 100644 --- a/src/functions/private/Users/Get-GitHubUserByName.ps1 +++ b/src/functions/private/Users/Get-GitHubUserByName.ps1 @@ -18,7 +18,7 @@ filter Get-GitHubUserByName { For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserByName -Name 'octocat' ``` diff --git a/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 index 8250a4bf9..04164fb3d 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserKeyForUser { Lists the _verified_ public SSH keys for a user. This is accessible by anyone. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserKeyForUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 index 3bd18437a..ef758320f 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubUserMyKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserMyKey ``` diff --git a/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 index b7023ce5e..7c4edfe3f 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubUserMyKeyById { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserMyKeyById -ID '1234567' ``` diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 index 1e50d513e..1f388ec12 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubUserMySigningKey { "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserMySigningKey ``` diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 index d912fc9e1..dfe095f47 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 @@ -10,7 +10,7 @@ filter Get-GitHubUserMySigningKeyById { "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserMySigningKeyById -ID '1234567' ``` diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 index e4b7d3884..5f7d3ec80 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserSigningKeyForUser { List SSH signing keys for a user .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserSigningKeyForUser -Username 'octocat' ``` diff --git a/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 b/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 index fa9abe237..052ab74a5 100644 --- a/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 +++ b/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubMyUserSocials { Lists all of your social accounts. .EXAMPLE - ```pwsh + ```powershell Get-GitHubMyUserSocials ``` diff --git a/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 b/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 index c19177063..9283b15db 100644 --- a/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 +++ b/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubUserSocialsByName { Lists social media accounts for a user. This endpoint is accessible by anyone. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserSocialsByName -Username 'octocat' ``` diff --git a/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 b/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 index e77426775..c663e9980 100644 --- a/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 +++ b/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 @@ -9,21 +9,21 @@ function Get-FunctionParameter { If a parameter is not provided, it will attempt to retrieve the default value. .EXAMPLE - ```pwsh + ```powershell Get-FunctionParameter ``` This will return all the parameters and their final value in the current function. .EXAMPLE - ```pwsh + ```powershell Get-FunctionParameter -IncludeCommonParameters ``` This will return all the parameters and their final value in the current function, including common parameters. .EXAMPLE - ```pwsh + ```powershell Get-FunctionParameter -Scope 2 ``` diff --git a/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 b/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 index 5dbee6571..17dd9bf81 100644 --- a/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 +++ b/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 @@ -10,7 +10,7 @@ function Get-PSCallStackPath { and the last (the current function, Get-PSCallStackPath). .EXAMPLE - ```pwsh + ```powershell Get-PSCallStackPath First-Function\Second-Function\Third-Function ``` @@ -19,7 +19,7 @@ function Get-PSCallStackPath { and last (Get-PSCallStackPath) functions removed. .EXAMPLE - ```pwsh + ```powershell Get-PSCallStackPath -SkipFirst 0 \First-Function\Second-Function\Third-Function ``` @@ -27,7 +27,7 @@ function Get-PSCallStackPath { Shows the call stack of the last function called, Third-Function, with the first function included (typically ). .EXAMPLE - ```pwsh + ```powershell Get-PSCallStackPath -SkipLatest 0 First-Function\Second-Function\Third-Function\Get-PSCallStackPath ``` diff --git a/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 b/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 index 5794608cf..dd36d321d 100644 --- a/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 +++ b/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 @@ -8,7 +8,7 @@ function Test-GitHubAzPowerShell { It verifies both the availability of the module and the authentication status. .EXAMPLE - ```pwsh + ```powershell Test-GitHubAzPowerShell ``` diff --git a/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 b/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 index 4cfb066e1..52acc9af8 100644 --- a/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 +++ b/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 @@ -8,7 +8,7 @@ function Test-GitHubAzureCLI { It verifies both the availability of the CLI tool and the authentication status. .EXAMPLE - ```pwsh + ```powershell Test-GitHubAzureCLI ``` diff --git a/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 index eb92fcf80..7064f0e15 100644 --- a/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 @@ -9,12 +9,12 @@ function Get-GitHubVariableEnvironmentByName { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableEnvironmentByName -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'NAME' -Context $GitHubContext ``` Output: - ```pwsh + ```powershell Name : NAME Value : John Doe Owner : octocat diff --git a/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 b/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 index 261ea9325..f0429711e 100644 --- a/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 @@ -9,12 +9,12 @@ function Get-GitHubVariableEnvironmentList { OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableEnvironmentList -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Context $GitHubContext ``` Output: - ```pwsh + ```powershell Name : NAME Value : John Doe Owner : octocat diff --git a/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 b/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 index edc90b4fc..50c5ba66d 100644 --- a/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 @@ -9,12 +9,12 @@ function Get-GitHubVariableFromOrganization { OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableFromOrganization -Owner 'PSModule' -Repository 'GitHub' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : AVAILVAR Value : ValueVar Owner : PSModule diff --git a/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 index b8978f529..5bc13f35b 100644 --- a/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 @@ -10,12 +10,12 @@ function Get-GitHubVariableOwnerByName { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableOwnerByName -Owner 'PSModule' -Name 'SELECTEDVAR' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : SELECTEDVAR Value : Varselected Owner : PSModule diff --git a/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 b/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 index cc08b5ed7..c097eebbd 100644 --- a/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 @@ -10,12 +10,12 @@ function Get-GitHubVariableOwnerList { the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableOwnerList -Owner 'PSModule' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : AVAILVAR Value : ValueVar Owner : PSModule diff --git a/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 index 07b6e9d20..00081bc94 100644 --- a/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 @@ -9,12 +9,12 @@ function Get-GitHubVariableRepositoryByName { OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableRepositoryByName -Owner 'PSModule' -Repository 'Hello-World' -Name 'EMAIL' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : EMAIL Value : John.Doe@example.com Owner : octocat diff --git a/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 b/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 index 58f728fdd..d405a89be 100644 --- a/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 @@ -9,12 +9,12 @@ function Get-GitHubVariableRepositoryList { OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableRepositoryList -Owner 'PSModule' -Repository 'Hello-World' -Context (Get-GitHubContext) ``` Output: - ```pwsh + ```powershell Name : NAME Value : John Doe Owner : octocat diff --git a/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 b/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 index 697a4ce4b..ca086f8e7 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 @@ -9,7 +9,7 @@ function New-GitHubVariableOnEnvironment { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repository = 'Hello-World' diff --git a/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 b/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 index 658f915a6..7f3f719ed 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 @@ -10,7 +10,7 @@ function New-GitHubVariableOnOwner { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell New-GitHubVariableOnOwner -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` diff --git a/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 b/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 index 95c40b666..77e378d71 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 @@ -9,7 +9,7 @@ function New-GitHubVariableOnRepository { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell New-GitHubVariableOnRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 index 387e15adf..d940f45ba 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 @@ -9,7 +9,7 @@ function Remove-GitHubVariableFromEnvironment { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubVariableFromEnvironment -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Context $GitHubContext ``` diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 index 21b70e378..a1bb55e07 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 @@ -10,7 +10,7 @@ function Remove-GitHubVariableFromOwner { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubVariableFromOwner -Owner 'octocat' -Name 'HOST_NAME' -Context $GitHubContext ``` diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 index 26a74c34f..b4148ed0b 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 @@ -9,7 +9,7 @@ function Remove-GitHubVariableFromRepository { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubVariableFromRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Context $GitHubContext ``` diff --git a/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 index 051c7a031..55fbf9868 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 @@ -10,7 +10,7 @@ function Update-GitHubVariableOnEnvironment { .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repository = 'Hello-World' diff --git a/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 index dac9a0c51..a3b2b32fe 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 @@ -10,7 +10,7 @@ function Update-GitHubVariableOnOwner { the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell Update-GitHubVariableOnOwner -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` diff --git a/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 index b6e2dd252..8591c5182 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 @@ -9,7 +9,7 @@ function Update-GitHubVariableOnRepository { OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Update-GitHubVariableOnRepository -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 index e2e4f30af..cb4813128 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 @@ -11,7 +11,7 @@ function Get-GitHubAppWebhookDeliveryByID { .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppWebhookDeliveryByID -ID 123456 ``` diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 index 966c4e837..2ced60df7 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 @@ -10,7 +10,7 @@ function Get-GitHubAppWebhookDeliveryByList { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppWebhookDeliveryByList ``` diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 index 4765a307c..5a645d0d9 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 @@ -7,7 +7,7 @@ function Get-GitHubAppWebhookDeliveryToRedeliver { Long description .EXAMPLE - ```pwsh + ```powershell An example ``` diff --git a/src/functions/public/API/Invoke-GitHubAPI.ps1 b/src/functions/public/API/Invoke-GitHubAPI.ps1 index dc2cd5f99..48e65d150 100644 --- a/src/functions/public/API/Invoke-GitHubAPI.ps1 +++ b/src/functions/public/API/Invoke-GitHubAPI.ps1 @@ -11,21 +11,21 @@ function Invoke-GitHubAPI { It automatically handles the endpoint URI construction, headers, and token authentication. .EXAMPLE - ```pwsh + ```powershell Invoke-GitHubAPI -ApiEndpoint '/repos/user/repo/pulls' -Method GET ``` Gets all open pull requests for the specified repository. .EXAMPLE - ```pwsh + ```powershell Invoke-GitHubAPI -ApiEndpoint '/repos/user/repo/pulls' -Method GET -Body @{ state = 'open' } ``` Gets all open pull requests for the specified repository, filtered by the 'state' parameter. .EXAMPLE - ```pwsh + ```powershell Invoke-GitHubAPI -ApiEndpoint '/repos/user/repo/pulls' -Method GET -Body @{ state = 'open' } -Accept 'application/vnd.github.v3+json' ``` diff --git a/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 b/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 index 5ef8eb993..bf24b44d7 100644 --- a/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 +++ b/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 @@ -7,7 +7,7 @@ function Invoke-GitHubGraphQLQuery { Use this function to invoke a GraphQL query and mutations against the GitHub GraphQL API with proper error handling. .EXAMPLE - ```pwsh + ```powershell Invoke-GitHubGraphQLQuery -Query $query -Variables $Variables ``` diff --git a/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 b/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 index 0b833be2e..25913a1b5 100644 --- a/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 +++ b/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 @@ -7,7 +7,7 @@ function Get-GitHubEventData { Gets data about the event that triggered the workflow. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEventData ``` diff --git a/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 b/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 index 041a011dc..3e365ec64 100644 --- a/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 +++ b/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 @@ -7,7 +7,7 @@ function Get-GitHubRunnerData { Gets data about the runner thats running the workflow. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRunnerData ``` diff --git a/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 index 82175c1b0..5ba0ae9c8 100644 --- a/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 @@ -7,7 +7,7 @@ function Add-GitHubAppInstallationRepositoryAccess { Grant repository access to an organization installation. .EXAMPLE - ```pwsh + ```powershell $params = @{ Enterprise = 'msx' Organization = 'PSModule' diff --git a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 index 2b2614fbb..e5c7ce785 100644 --- a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 @@ -11,7 +11,7 @@ function Get-GitHubAppAccessibleRepository { permission. .EXAMPLE - ```pwsh + ```powershell $params = @{ Enterprise = 'msx' Organization = 'PSModule' diff --git a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 index cd428a778..f9398e160 100644 --- a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 @@ -9,7 +9,7 @@ function Get-GitHubAppInstallationRepositoryAccess { The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (read) permission. .EXAMPLE - ```pwsh + ```powershell $params = @{ Enterprise = 'msx' Organization = 'PSModule' diff --git a/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 b/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 index 68c60ed0a..e984f5092 100644 --- a/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 @@ -28,14 +28,14 @@ filter New-GitHubAppInstallationAccessToken { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell New-GitHubAppInstallationAccessToken -InstallationID 12345678 ``` Creates an installation access token for the installation with the ID `12345678`. .EXAMPLE - ```pwsh + ```powershell Connect-GitHub -ClientID $ClientID -PrivateKey $PrivateKey Get-GitHubAppInstallation | New-GitHubAppInstallationAccessToken ``` diff --git a/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 index 816410e92..b43942120 100644 --- a/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 @@ -7,7 +7,7 @@ function Remove-GitHubAppInstallationRepositoryAccess { Remove repository access to an organization installation. .EXAMPLE - ```pwsh + ```powershell $params = @{ Enterprise = 'msx' Organization = 'PSModule' diff --git a/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 index 77e8f0aa7..eae64501f 100644 --- a/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 @@ -7,7 +7,7 @@ function Update-GitHubAppInstallationRepositoryAccess { Update repository access for a GitHub App installation between all repositories and selected repositories. .EXAMPLE - ```pwsh + ```powershell Update-GitHubAppInstallationRepositoryAccess -Enterprise 'msx' -Organization 'PSModule' -InstallationID 12345678 -RepositorySelection 'all' ``` @@ -15,7 +15,7 @@ function Update-GitHubAppInstallationRepositoryAccess { to all repositories on the organization 'PSModule' in the enterprise 'msx'. .EXAMPLE - ```pwsh + ```powershell $params = @{ Enterprise = 'msx' Organization = 'PSModule' diff --git a/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 index ab6c00f68..96d5499c1 100644 --- a/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 @@ -7,14 +7,14 @@ filter Get-GitHubApp { Returns a GitHub App associated with the authentication credentials used or the provided app-slug. .EXAMPLE - ```pwsh + ```powershell Get-GitHubApp ``` Get the authenticated app. .EXAMPLE - ```pwsh + ```powershell Get-GitHubApp -Slug 'github-actions' ``` diff --git a/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 b/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 index 0331aed9a..c51ab2ff6 100644 --- a/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 +++ b/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubAppInstallationRequest { Lists all the pending installation requests for the authenticated GitHub App. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppInstallationRequest ``` diff --git a/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 index 2fef6570d..1de5d2b58 100644 --- a/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 @@ -7,7 +7,7 @@ function Install-GitHubApp { Installs the provided GitHub App on the specified target. .EXAMPLE - ```pwsh + ```powershell Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'selected' -Repositories 'repo1', 'repo2' ``` @@ -18,7 +18,7 @@ function Install-GitHubApp { on the organization 'org' in the enterprise 'msx'. .EXAMPLE - ```pwsh + ```powershell Install-GitHubApp -Enterprise 'msx' -Organization 'org' -ClientID '123456' -RepositorySelection 'all' ``` diff --git a/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 index ce8031697..dc3f4258a 100644 --- a/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 @@ -9,7 +9,7 @@ function Uninstall-GitHubApp { - As an enterprise installation (IAT/UAT context with Enterprise): remove an app from an organization by InstallationID or AppSlug. .EXAMPLE - ```pwsh + ```powershell Uninstall-GitHubApp -Target 'octocat' Uninstall-GitHubApp -Target 12345 ``` @@ -17,21 +17,21 @@ function Uninstall-GitHubApp { As an App: uninstall by target name (enterprise/org/user) or by exact installation ID .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppInstallation | Uninstall-GitHubApp ``` As an App: uninstall using pipeline objects .EXAMPLE - ```pwsh + ```powershell Uninstall-GitHubApp -Organization 'org' -InstallationID 123456 -Context (Connect-GitHubApp -Enterprise 'msx' -PassThru) ``` As an enterprise installation: uninstall by installation ID in an org .EXAMPLE - ```pwsh + ```powershell Uninstall-GitHubApp -Organization 'org' -AppSlug 'my-app' -Context (Connect-GitHubApp -Enterprise 'msx' -PassThru) ``` diff --git a/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 index eb538032c..b62246643 100644 --- a/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 @@ -12,12 +12,12 @@ function Get-GitHubArtifact { - FromRepository: Retrieve artifacts from a repository, optionally by name or with all versions. .EXAMPLE - ```pwsh + ```powershell Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -ID '123456' ``` Output: - ```pwsh + ```powershell Name : artifact-1 ID : 123456 SizeInBytes : 2048 @@ -27,12 +27,12 @@ function Get-GitHubArtifact { Retrieves a single GitHub Actions artifact using its unique artifact ID. .EXAMPLE - ```pwsh + ```powershell Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -WorkflowRunID '987654321' ``` Output: - ```pwsh + ```powershell Name : test-results ID : 456789 SizeInBytes : 4096 @@ -42,12 +42,12 @@ function Get-GitHubArtifact { Retrieves the latest version of all artifacts from the specified workflow run. .EXAMPLE - ```pwsh + ```powershell Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -WorkflowRunID '987654321' -AllVersions ``` Output: - ```pwsh + ```powershell Name : test-results ID : 4564584673 SizeInBytes : 4096 @@ -62,12 +62,12 @@ function Get-GitHubArtifact { Retrieves all versions of all artifacts from the specified workflow run. .EXAMPLE - ```pwsh + ```powershell Get-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' ``` Output: - ```pwsh + ```powershell Name : build-artifact ID : 998877 SizeInBytes : 8192 diff --git a/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 index 2b6a26025..4ff24581f 100644 --- a/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 @@ -10,7 +10,7 @@ function Remove-GitHubArtifact { The function uses the GitHub REST API to perform the deletion and supports `ShouldProcess` for safe execution. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubArtifact -Owner 'octocat' -Repository 'demo-repo' -ID '123456' ``` diff --git a/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 index acb71dcc5..34cc84e9b 100644 --- a/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 @@ -9,12 +9,12 @@ function Save-GitHubArtifact { personal access tokens (classic) or OAuth tokens with the `repo` scope are required. .EXAMPLE - ```pwsh + ```powershell Save-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -ID '123456' -Path 'C:\Artifacts' ``` Output: - ```pwsh + ```powershell Directory: C:\Artifacts Mode LastWriteTime Length Name @@ -25,12 +25,12 @@ function Save-GitHubArtifact { Downloads artifact ID '123456' from the 'Hello-World' repository owned by 'octocat' to the specified path. .EXAMPLE - ```pwsh + ```powershell Save-GitHubArtifact -Owner 'octocat' -Repository 'Hello-World' -Name 'module' -Path 'C:\Artifacts\module' -Expand -Force ``` Output: - ```pwsh + ```powershell Directory: C:\Artifacts Mode LastWriteTime Length Name diff --git a/src/functions/public/Auth/Connect-GitHubAccount.ps1 b/src/functions/public/Auth/Connect-GitHubAccount.ps1 index 9268325de..3da72514f 100644 --- a/src/functions/public/Auth/Connect-GitHubAccount.ps1 +++ b/src/functions/public/Auth/Connect-GitHubAccount.ps1 @@ -17,7 +17,7 @@ function Connect-GitHubAccount { the app will be able to make API calls with a new access token. .EXAMPLE - ```pwsh + ```powershell Connect-GitHubAccount ``` @@ -25,7 +25,7 @@ function Connect-GitHubAccount { If the user has already logged in, the access token will be refreshed. .EXAMPLE - ```pwsh + ```powershell $env:GH_TOKEN = '***' Connect-GitHubAccount ``` @@ -33,7 +33,7 @@ function Connect-GitHubAccount { Connects to GitHub using the access token from environment variable, assuming unattended mode. .EXAMPLE - ```pwsh + ```powershell Connect-GitHubAccount -UseAccessToken ! Enter your personal access token: ************* ``` @@ -42,7 +42,7 @@ function Connect-GitHubAccount { The token is used when connecting to GitHub. .EXAMPLE - ```pwsh + ```powershell Connect-GitHubAccount -Mode 'OAuthApp' -Scope 'gist read:org repo workflow' ``` diff --git a/src/functions/public/Auth/Connect-GitHubApp.ps1 b/src/functions/public/Auth/Connect-GitHubApp.ps1 index f07e72c54..81d85e136 100644 --- a/src/functions/public/Auth/Connect-GitHubApp.ps1 +++ b/src/functions/public/Auth/Connect-GitHubApp.ps1 @@ -12,28 +12,28 @@ function Connect-GitHubApp { - Enterprise .EXAMPLE - ```pwsh + ```powershell Connect-GitHubApp ``` Connects to GitHub as all available targets using the logged in GitHub App. .EXAMPLE - ```pwsh + ```powershell Connect-GitHubApp -User 'octocat' ``` Connects to GitHub as the user 'octocat' using the logged in GitHub App. .EXAMPLE - ```pwsh + ```powershell Connect-GitHubApp -Organization 'psmodule' -Default ``` Connects to GitHub as the organization 'psmodule' using the logged in GitHub App and sets it as the default context. .EXAMPLE - ```pwsh + ```powershell Connect-GitHubApp -Enterprise 'msx' ``` diff --git a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 b/src/functions/public/Auth/Context/Get-GitHubContext.ps1 index b00df00ee..70193d3e2 100644 --- a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 +++ b/src/functions/public/Auth/Context/Get-GitHubContext.ps1 @@ -7,7 +7,7 @@ function Get-GitHubContext { Get the current GitHub context. .EXAMPLE - ```pwsh + ```powershell Get-GitHubContext ``` diff --git a/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 b/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 index 07fdf1cf7..2978cfc29 100644 --- a/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 +++ b/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 @@ -7,7 +7,7 @@ function Switch-GitHubContext { Set the default context for the GitHub module. .EXAMPLE - ```pwsh + ```powershell Switch-GitHubContext -Context 'github.com/Octocat' ``` diff --git a/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 b/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 index a2d126e15..fff722c6c 100644 --- a/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 +++ b/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 @@ -8,28 +8,28 @@ function Disconnect-GitHubAccount { to ensure it cannot be used after disconnection. .EXAMPLE - ```pwsh + ```powershell Disconnect-GitHubAccount ``` Disconnects from GitHub and removes the default GitHub context. .EXAMPLE - ```pwsh + ```powershell Disconnect-GithubAccount -Context 'github.com/Octocat' ``` Disconnects from GitHub and removes the context 'github.com/Octocat'. .EXAMPLE - ```pwsh + ```powershell Disconnect-GitHubAccount -RevokeToken ``` Disconnects from GitHub, revokes the access token, and removes the default GitHub context. .EXAMPLE - ```pwsh + ```powershell Disconnect-GithubAccount -Context 'github.com/Octocat' -RevokeToken ``` diff --git a/src/functions/public/Auth/Get-GitHubAccessToken.ps1 b/src/functions/public/Auth/Get-GitHubAccessToken.ps1 index 5923dd459..b5c070071 100644 --- a/src/functions/public/Auth/Get-GitHubAccessToken.ps1 +++ b/src/functions/public/Auth/Get-GitHubAccessToken.ps1 @@ -10,24 +10,24 @@ function Get-GitHubAccessToken { Use this function to extract authentication tokens for subsequent API requests. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAccessToken ``` Output: - ```pwsh + ```powershell System.Security.SecureString ``` Retrieves the access token from the default context as a secure string. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAccessToken -Context $myGitHubContext -AsPlainText ``` Output: - ```pwsh + ```powershell ghp_exampletoken1234567890 ``` diff --git a/src/functions/public/Auth/Get-GitHubViewer.ps1 b/src/functions/public/Auth/Get-GitHubViewer.ps1 index 2ffd71876..c7b69f9b7 100644 --- a/src/functions/public/Auth/Get-GitHubViewer.ps1 +++ b/src/functions/public/Auth/Get-GitHubViewer.ps1 @@ -7,7 +7,7 @@ function Get-GitHubViewer { Gets the currently authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GithubViewer ``` diff --git a/src/functions/public/Commands/Add-GitHubMask.ps1 b/src/functions/public/Commands/Add-GitHubMask.ps1 index 98a36df47..5c2eba8e2 100644 --- a/src/functions/public/Commands/Add-GitHubMask.ps1 +++ b/src/functions/public/Commands/Add-GitHubMask.ps1 @@ -10,14 +10,14 @@ filter Add-GitHubMask { set that value as an output. .EXAMPLE - ```pwsh + ```powershell Add-Mask $SecretValue ``` Masks the value of $SecretValue so that its printed like ***. .EXAMPLE - ```pwsh + ```powershell $SecretValue1, $SecretValue2 | Mask ``` diff --git a/src/functions/public/Commands/Add-GitHubSystemPath.ps1 b/src/functions/public/Commands/Add-GitHubSystemPath.ps1 index e43cfdba6..c9cffe51a 100644 --- a/src/functions/public/Commands/Add-GitHubSystemPath.ps1 +++ b/src/functions/public/Commands/Add-GitHubSystemPath.ps1 @@ -9,7 +9,7 @@ function Add-GitHubSystemPath { echo "$env:PATH" in a step or an action. .EXAMPLE - ```pwsh + ```powershell Add-GitHubSystemPath -Path '$HOME/.local/bin' ``` diff --git a/src/functions/public/Commands/Disable-GitHubCommand.ps1 b/src/functions/public/Commands/Disable-GitHubCommand.ps1 index 3c421e863..c2e65647b 100644 --- a/src/functions/public/Commands/Disable-GitHubCommand.ps1 +++ b/src/functions/public/Commands/Disable-GitHubCommand.ps1 @@ -11,7 +11,7 @@ function Disable-GitHubCommand { that you used to stop workflow commands to the Enable-GitHubCommand. .EXAMPLE - ```pwsh + ```powershell Disable-GitHubCommand "123" ``` diff --git a/src/functions/public/Commands/Enable-GitHubCommand.ps1 b/src/functions/public/Commands/Enable-GitHubCommand.ps1 index d4dbfa0dd..bbc33575b 100644 --- a/src/functions/public/Commands/Enable-GitHubCommand.ps1 +++ b/src/functions/public/Commands/Enable-GitHubCommand.ps1 @@ -10,7 +10,7 @@ function Enable-GitHubCommand { that you used to stop workflow commands to the Enable-GitHubCommand. .EXAMPLE - ```pwsh + ```powershell Enable-GitHubCommand "123" ``` diff --git a/src/functions/public/Commands/Get-GitHubOutput.ps1 b/src/functions/public/Commands/Get-GitHubOutput.ps1 index 5a660c9d9..f5730f9d6 100644 --- a/src/functions/public/Commands/Get-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Get-GitHubOutput.ps1 @@ -7,7 +7,7 @@ function Get-GitHubOutput { Gets the GitHub output from $env:GITHUB_OUTPUT and creates an object with key-value pairs, supporting both single-line and multi-line values .EXAMPLE - ```pwsh + ```powershell Get-GitHubOutput MY_VALUE result zen -------- ------ --- @@ -17,7 +17,7 @@ function Get-GitHubOutput { Gets the GitHub output and returns an object with key-value pairs. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOutput -AsHashtable ``` diff --git a/src/functions/public/Commands/Reset-GitHubOutput.ps1 b/src/functions/public/Commands/Reset-GitHubOutput.ps1 index 30d88a7c5..e85d0c20f 100644 --- a/src/functions/public/Commands/Reset-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Reset-GitHubOutput.ps1 @@ -7,7 +7,7 @@ function Reset-GitHubOutput { Resets the GitHub output by clearing the contents of $env:GITHUB_OUTPUT. .EXAMPLE - ```pwsh + ```powershell Reset-GitHubOutput ``` diff --git a/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 b/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 index 556156cfd..173dd2aff 100644 --- a/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 +++ b/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 @@ -7,7 +7,7 @@ function Set-GitHubEnvironmentVariable { Set a GitHub environment variable .EXAMPLE - ```pwsh + ```powershell Set-GitHubEnv -Name 'MyVariable' -Value 'MyValue' ``` diff --git a/src/functions/public/Commands/Set-GitHubLogGroup.ps1 b/src/functions/public/Commands/Set-GitHubLogGroup.ps1 index 558629065..64bce26c9 100644 --- a/src/functions/public/Commands/Set-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Set-GitHubLogGroup.ps1 @@ -8,7 +8,7 @@ function Set-GitHubLogGroup { Allows for colapsing of code in IDE for code that belong together. .EXAMPLE - ```pwsh + ```powershell Set-GitHubLogGroup -Name 'MyGroup' -ScriptBlock { Write-Host 'Hello, World!' } @@ -17,7 +17,7 @@ function Set-GitHubLogGroup { Creates a new log group named 'MyGroup' and writes 'Hello, World!' to the output. .EXAMPLE - ```pwsh + ```powershell LogGroup 'MyGroup' { Write-Host 'Hello, World!' } diff --git a/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 b/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 index ba99c94b1..367967b6c 100644 --- a/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 +++ b/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 @@ -8,7 +8,7 @@ function Set-GitHubNoCommandGroup { Allows for colapsing of code in IDE for code that belong together. .EXAMPLE - ```pwsh + ```powershell Set-GitHubNoCommandGroup { Write-Host 'Hello, World!' Write-GithubError 'This is an error' @@ -18,7 +18,7 @@ function Set-GitHubNoCommandGroup { Groups commands where no workflow commands are run. .EXAMPLE - ```pwsh + ```powershell NoLogGroup 'MyGroup' { Write-Host 'Hello, World!' Write-GithubError 'This is an error' diff --git a/src/functions/public/Commands/Set-GitHubOutput.ps1 b/src/functions/public/Commands/Set-GitHubOutput.ps1 index 7ddd57f65..2216a9688 100644 --- a/src/functions/public/Commands/Set-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Set-GitHubOutput.ps1 @@ -13,14 +13,14 @@ function Set-GitHubOutput { The Value parameter accepts null values, which will be correctly preserved and set as the output. .EXAMPLE - ```pwsh + ```powershell Set-GitHubOutput -Name 'ID' -Value '123123123' ``` Sets the output variable 'ID' to '123123123' in the GitHub Actions output file. .EXAMPLE - ```pwsh + ```powershell Set-GitHubOutput -Name 'result' -Value @{ ID = '123123123' name = 'test' diff --git a/src/functions/public/Commands/Set-GitHubStepSummary.ps1 b/src/functions/public/Commands/Set-GitHubStepSummary.ps1 index 8cbfcbc94..6fabeeed0 100644 --- a/src/functions/public/Commands/Set-GitHubStepSummary.ps1 +++ b/src/functions/public/Commands/Set-GitHubStepSummary.ps1 @@ -16,7 +16,7 @@ function Set-GitHubStepSummary { workflow run summary page. If multiple jobs generate summaries, the job summaries are ordered by job completion time. .EXAMPLE - ```pwsh + ```powershell Set-GitHubStepSummary -Summary 'Hello, World!' ``` diff --git a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 index 4d81a5426..4cea360a6 100644 --- a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 @@ -14,8 +14,8 @@ function Start-GitHubLogGroup { This corresponds to the `::group::{title}` workflow command in GitHub Actions. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Start-GitHubLogGroup 'MyGroup' ``` ``` @@ -24,8 +24,8 @@ function Start-GitHubLogGroup { until Stop-GitHubLogGroup is called. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Start-GitHubLogGroup 'Building application' Write-Host 'Step 1: Restoring packages' Write-Host 'Step 2: Compiling code' diff --git a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 index acbc96019..933c6eff6 100644 --- a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 @@ -13,8 +13,8 @@ function Stop-GitHubLogGroup { This corresponds to the `::endgroup::` workflow command in GitHub Actions. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Stop-GitHubLogGroup ``` ``` @@ -22,8 +22,8 @@ function Stop-GitHubLogGroup { Stops the current log group in GitHub Actions. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Start-GitHubLogGroup 'Deployment Steps' Write-Host 'Deploying to staging...' Write-Host 'Deployment complete' diff --git a/src/functions/public/Commands/Write-GitHubDebug.ps1 b/src/functions/public/Commands/Write-GitHubDebug.ps1 index cebc540bf..d3c3f01b4 100644 --- a/src/functions/public/Commands/Write-GitHubDebug.ps1 +++ b/src/functions/public/Commands/Write-GitHubDebug.ps1 @@ -11,7 +11,7 @@ function Write-GitHubDebug { If both the secret and variable are set, the value of the secret takes precedence over the variable. .EXAMPLE - ```pwsh + ```powershell Write-GitHubDebug -Message 'Hello, World!' ``` diff --git a/src/functions/public/Commands/Write-GitHubError.ps1 b/src/functions/public/Commands/Write-GitHubError.ps1 index 473c6ae00..11acae710 100644 --- a/src/functions/public/Commands/Write-GitHubError.ps1 +++ b/src/functions/public/Commands/Write-GitHubError.ps1 @@ -7,7 +7,7 @@ function Write-GitHubError { Write a error message in GitHub Actions. The message will be displayed in the GitHub Actions log. .EXAMPLE - ```pwsh + ```powershell Write-GitHubError -Message 'Hello, World!' ``` diff --git a/src/functions/public/Commands/Write-GitHubLog.ps1 b/src/functions/public/Commands/Write-GitHubLog.ps1 index dfe9d84ca..f09b17927 100644 --- a/src/functions/public/Commands/Write-GitHubLog.ps1 +++ b/src/functions/public/Commands/Write-GitHubLog.ps1 @@ -9,21 +9,21 @@ function Write-GitHubLog { When not running in GitHub Actions, uses standard Write-Host. .EXAMPLE - ```pwsh + ```powershell Write-GitHubLog -Message 'Hello, World!' ``` Writes 'Hello, World!' to the log. .EXAMPLE - ```pwsh + ```powershell Write-GitHubLog -Message 'Error occurred!' -ForegroundColor Red ``` Writes 'Error occurred!' in red text. .EXAMPLE - ```pwsh + ```powershell Write-GitHubLog -Message 'Success!' -ForegroundColor Green -BackgroundColor Black ``` diff --git a/src/functions/public/Commands/Write-GitHubNotice.ps1 b/src/functions/public/Commands/Write-GitHubNotice.ps1 index 1da3350f3..167677303 100644 --- a/src/functions/public/Commands/Write-GitHubNotice.ps1 +++ b/src/functions/public/Commands/Write-GitHubNotice.ps1 @@ -7,7 +7,7 @@ function Write-GitHubNotice { Write a notice message in GitHub Actions. The message will be displayed in the GitHub Actions log. .EXAMPLE - ```pwsh + ```powershell Write-GitHubNotice -Message 'Hello, World!' ``` diff --git a/src/functions/public/Commands/Write-GitHubWarning.ps1 b/src/functions/public/Commands/Write-GitHubWarning.ps1 index 39fca9bdd..fcf3e7997 100644 --- a/src/functions/public/Commands/Write-GitHubWarning.ps1 +++ b/src/functions/public/Commands/Write-GitHubWarning.ps1 @@ -7,7 +7,7 @@ function Write-GitHubWarning { Write a warning message in GitHub Actions. The message will be displayed in the GitHub Actions log. .EXAMPLE - ```pwsh + ```powershell Write-GitHubWarning -Message 'Hello, World!' ``` diff --git a/src/functions/public/Config/Get-GitHubConfig.ps1 b/src/functions/public/Config/Get-GitHubConfig.ps1 index ad6821e10..a671d48c0 100644 --- a/src/functions/public/Config/Get-GitHubConfig.ps1 +++ b/src/functions/public/Config/Get-GitHubConfig.ps1 @@ -7,7 +7,7 @@ function Get-GitHubConfig { Get a GitHub module configuration. .EXAMPLE - ```pwsh + ```powershell Get-GitHubConfig -Name DefaultContext ``` diff --git a/src/functions/public/Config/Remove-GitHubConfig.ps1 b/src/functions/public/Config/Remove-GitHubConfig.ps1 index 6d1bd3657..60a3b0c32 100644 --- a/src/functions/public/Config/Remove-GitHubConfig.ps1 +++ b/src/functions/public/Config/Remove-GitHubConfig.ps1 @@ -7,7 +7,7 @@ function Remove-GitHubConfig { Remove a GitHub module configuration. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubConfig -Name DefaultUser ``` diff --git a/src/functions/public/Config/Reset-GitHubConfig.ps1 b/src/functions/public/Config/Reset-GitHubConfig.ps1 index a8e3ae8f9..2f1589301 100644 --- a/src/functions/public/Config/Reset-GitHubConfig.ps1 +++ b/src/functions/public/Config/Reset-GitHubConfig.ps1 @@ -7,7 +7,7 @@ function Reset-GitHubConfig { Re-initializes the GitHub module configuration. .EXAMPLE - ```pwsh + ```powershell Reset-GitHubConfig ``` diff --git a/src/functions/public/Config/Set-GitHubConfig.ps1 b/src/functions/public/Config/Set-GitHubConfig.ps1 index 72d0a5546..05deca625 100644 --- a/src/functions/public/Config/Set-GitHubConfig.ps1 +++ b/src/functions/public/Config/Set-GitHubConfig.ps1 @@ -7,7 +7,7 @@ function Set-GitHubConfig { Set a GitHub module configuration. .EXAMPLE - ```pwsh + ```powershell Set-GitHubConfig -Name DefaultUser -Value 'Octocat' ``` diff --git a/src/functions/public/Emojis/Get-GitHubEmoji.ps1 b/src/functions/public/Emojis/Get-GitHubEmoji.ps1 index 4e9ce1689..78e9e9ea1 100644 --- a/src/functions/public/Emojis/Get-GitHubEmoji.ps1 +++ b/src/functions/public/Emojis/Get-GitHubEmoji.ps1 @@ -8,14 +8,14 @@ filter Get-GitHubEmoji { If you pass the `Path` parameter, the emojis will be downloaded to the specified destination. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEmoji ``` Gets all the emojis available to use on GitHub. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEmoji -Path 'C:\Users\user\Documents\GitHub\Emojis' ``` diff --git a/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 b/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 index df9902fcd..ade85596d 100644 --- a/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 +++ b/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 @@ -9,12 +9,12 @@ function Get-GitHubEnterprise { specific enterprise name is provided, details about that single instance are returned. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnterprise ``` Output: - ```pwsh + ```powershell Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise @@ -29,12 +29,12 @@ function Get-GitHubEnterprise { Retrieves details about all GitHub Enterprise instances for the user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnterprise -Name 'my-enterprise' ``` Output: - ```pwsh + ```powershell Name : My Enterprise Slug : my-enterprise URL : https://github.com/enterprises/my-enterprise diff --git a/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 b/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 index be0890ff4..144c5099f 100644 --- a/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 +++ b/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 @@ -7,7 +7,7 @@ function Get-GitHubEnterpriseOrganization { Use this function to retrieve the list of organizations in a GitHub Enterprise instance. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnterpriseOrganization -Enterprise 'msx' ``` diff --git a/src/functions/public/Environments/Get-GitHubEnvironment.ps1 b/src/functions/public/Environments/Get-GitHubEnvironment.ps1 index 7073eb888..0afcecfda 100644 --- a/src/functions/public/Environments/Get-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Get-GitHubEnvironment.ps1 @@ -12,12 +12,12 @@ filter Get-GitHubEnvironment { to use this function with a private repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnvironment -Owner 'PSModule' -Repository 'EnvironmentTest' -Name 'test' ``` Output: - ```pwsh + ```powershell id : 5944178128 node_id : EN_kwDOOJqfM88AAAABYkz10A name : test @@ -35,12 +35,12 @@ filter Get-GitHubEnvironment { Retrieves details of the "test" environment in the specified repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubEnvironment -Owner 'PSModule' -Repository 'EnvironmentTest' ``` Output: - ```pwsh + ```powershell id : 5944178128 node_id : EN_kwDOOJqfM88AAAABYkz10A name : test diff --git a/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 b/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 index 23ffe5c3c..54bddde08 100644 --- a/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 @@ -8,7 +8,7 @@ filter Remove-GitHubEnvironment { The function supports ShouldProcess for confirmation before execution. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubEnvironment -Owner 'PSModule' -Repository 'GitHub' -Name 'Production' ``` diff --git a/src/functions/public/Environments/Set-GitHubEnvironment.ps1 b/src/functions/public/Environments/Set-GitHubEnvironment.ps1 index b7f4f5e0b..1efd32afb 100644 --- a/src/functions/public/Environments/Set-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Set-GitHubEnvironment.ps1 @@ -15,7 +15,7 @@ filter Set-GitHubEnvironment { OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = "my-org" Repository = "my-repo" @@ -28,7 +28,7 @@ filter Set-GitHubEnvironment { ``` Output: - ```pwsh + ```powershell id : 5944178128 node_id : EN_kwDOOJqfM88AAAABYkz10A name : test diff --git a/src/functions/public/Git/Get-GitHubGitConfig.ps1 b/src/functions/public/Git/Get-GitHubGitConfig.ps1 index 69c325776..8b56fba2b 100644 --- a/src/functions/public/Git/Get-GitHubGitConfig.ps1 +++ b/src/functions/public/Git/Get-GitHubGitConfig.ps1 @@ -7,7 +7,7 @@ function Get-GitHubGitConfig { Gets the global Git configuration. .EXAMPLE - ```pwsh + ```powershell Get-GitHubGitConfig ``` diff --git a/src/functions/public/Git/Set-GitHubGitConfig.ps1 b/src/functions/public/Git/Set-GitHubGitConfig.ps1 index 6e59f281d..901d6bea7 100644 --- a/src/functions/public/Git/Set-GitHubGitConfig.ps1 +++ b/src/functions/public/Git/Set-GitHubGitConfig.ps1 @@ -7,14 +7,14 @@ function Set-GitHubGitConfig { Sets the Git configuration for the GitHub context. This command sets the `user.name`, `user.email`, and `url..insteadOf` git configs. .EXAMPLE - ```pwsh + ```powershell Set-GitHubGitConfig ``` Sets the Git configuration for the default GitHub context. .EXAMPLE - ```pwsh + ```powershell Set-GitHubGitConfig -Context 'MyContext' ``` diff --git a/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 b/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 index 3dc2ea181..50ad963a8 100644 --- a/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 +++ b/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 @@ -8,14 +8,14 @@ filter Get-GitHubGitignore { If the Name parameter is specified, the function will return the gitignore template for the specified name. .EXAMPLE - ```pwsh + ```powershell Get-GitHubGitignoreList ``` Get all gitignore templates .EXAMPLE - ```pwsh + ```powershell Get-GitHubGitignore -Name 'VisualStudio' ``` diff --git a/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 b/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 index 323941875..0d0c7803e 100644 --- a/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 +++ b/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 @@ -8,7 +8,7 @@ function ConvertFrom-IssueForm { Section titles become keys and their content becomes values. .EXAMPLE - ```pwsh + ```powershell @' ### Section 1 Content 1 diff --git a/src/functions/public/License/Get-GitHubLicense.ps1 b/src/functions/public/License/Get-GitHubLicense.ps1 index 7a218d9dd..72a568495 100644 --- a/src/functions/public/License/Get-GitHubLicense.ps1 +++ b/src/functions/public/License/Get-GitHubLicense.ps1 @@ -9,21 +9,21 @@ filter Get-GitHubLicense { If the Owner and Repo parameters are specified, the function will return the license for the specified repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubLicense ``` Get all license templates .EXAMPLE - ```pwsh + ```powershell Get-GitHubLicense -Name mit ``` Get the mit license template .EXAMPLE - ```pwsh + ```powershell Get-GitHubLicense -Owner 'octocat' -Repository 'Hello-World' ``` diff --git a/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 b/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 index 37fdaa2e4..e644c96a5 100644 --- a/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 +++ b/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubMarkdown { Converts Markdown to HTML .EXAMPLE - ```pwsh + ```powershell Get-GitHubMarkdown -Text "Hello **world**" "

Hello world

" ``` diff --git a/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 b/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 index 1c8699deb..472210353 100644 --- a/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 +++ b/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubMarkdownRaw { format like a README.md file. Markdown content must be 400 KB or less. .EXAMPLE - ```pwsh + ```powershell Get-GitHubMarkdownRaw -Text 'Hello, world!' "

Hello world

" ``` diff --git a/src/functions/public/Meta/Get-GitHubApiVersion.ps1 b/src/functions/public/Meta/Get-GitHubApiVersion.ps1 index f48864977..5f66726f2 100644 --- a/src/functions/public/Meta/Get-GitHubApiVersion.ps1 +++ b/src/functions/public/Meta/Get-GitHubApiVersion.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubApiVersion { Get all supported GitHub API versions. .EXAMPLE - ```pwsh + ```powershell Get-GitHubApiVersion ``` diff --git a/src/functions/public/Meta/Get-GitHubMeta.ps1 b/src/functions/public/Meta/Get-GitHubMeta.ps1 index ee27c1bc9..7f1c2d802 100644 --- a/src/functions/public/Meta/Get-GitHubMeta.ps1 +++ b/src/functions/public/Meta/Get-GitHubMeta.ps1 @@ -15,7 +15,7 @@ filter Get-GitHubMeta { documentation for each feature to determine if IPv6 is supported. .EXAMPLE - ```pwsh + ```powershell Get-GitHubMeta ``` diff --git a/src/functions/public/Meta/Get-GitHubOctocat.ps1 b/src/functions/public/Meta/Get-GitHubOctocat.ps1 index 0799b7b12..815d2592c 100644 --- a/src/functions/public/Meta/Get-GitHubOctocat.ps1 +++ b/src/functions/public/Meta/Get-GitHubOctocat.ps1 @@ -7,14 +7,14 @@ filter Get-GitHubOctocat { Get the octocat as ASCII art. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOctocat ``` Get the octocat as ASCII art .EXAMPLE - ```pwsh + ```powershell Get-GitHubOctocat -S "Hello world" ``` diff --git a/src/functions/public/Meta/Get-GitHubRoot.ps1 b/src/functions/public/Meta/Get-GitHubRoot.ps1 index cb77e36d5..347fbb26c 100644 --- a/src/functions/public/Meta/Get-GitHubRoot.ps1 +++ b/src/functions/public/Meta/Get-GitHubRoot.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubRoot { Get Hypermedia links to resources accessible in GitHub's REST API. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRoot ``` diff --git a/src/functions/public/Meta/Get-GitHubZen.ps1 b/src/functions/public/Meta/Get-GitHubZen.ps1 index 2b0c593a4..d2a924549 100644 --- a/src/functions/public/Meta/Get-GitHubZen.ps1 +++ b/src/functions/public/Meta/Get-GitHubZen.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubZen { Get a random sentence from the Zen of GitHub. .EXAMPLE - ```pwsh + ```powershell Get-GitHubZen ``` diff --git a/src/functions/public/Organization/Get-GitHubOrganization.ps1 b/src/functions/public/Organization/Get-GitHubOrganization.ps1 index 67cefdcef..19fe46a12 100644 --- a/src/functions/public/Organization/Get-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Get-GitHubOrganization.ps1 @@ -10,35 +10,35 @@ filter Get-GitHubOrganization { Get an organization - if a organization name is provided. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganization ``` List all organizations for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganization -Username 'octocat' ``` List public organizations for a specific user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganization -All -Since 142951047 ``` List all organizations made after an ID. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganization -Name 'PSModule' ``` Get a specific organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganization -Enterprise 'msx' ``` diff --git a/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 b/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 index 1bae1d367..92d013c19 100644 --- a/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 +++ b/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 @@ -10,14 +10,14 @@ function Get-GitHubOrganizationPendingInvitation { member, the `login` field in the return hash will be `null`. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganizationPendingInvitation -Organization 'github' ``` List all pending organization invitations for the organization `github`. .EXAMPLE - ```pwsh + ```powershell Get-GitHubOrganizationPendingInvitation -Organization 'github' -Role 'admin' ``` diff --git a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 index c21fb3c65..0c3eb9347 100644 --- a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 @@ -13,8 +13,8 @@ function New-GitHubOrganizationInvitation { and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell New-GitHubOrganizationInvitation -Organization 'PSModule' -InviteeID 123456789 -Role 'admin' ``` ``` @@ -22,8 +22,8 @@ function New-GitHubOrganizationInvitation { Invites the user with the ID `12345679` to the organization `PSModule` with the role `admin`. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell New-GitHubOrganizationInvitation -Organization 'PSModule' -Email 'user@psmodule.io' ``` ``` diff --git a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 index 6faadef17..434412e37 100644 --- a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 @@ -9,8 +9,8 @@ function Remove-GitHubOrganizationInvitation { This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Remove-GitHubOrganizationInvitation -Organization 'github' -InvitationID '12345678' ``` ``` diff --git a/src/functions/public/Organization/New-GitHubOrganization.ps1 b/src/functions/public/Organization/New-GitHubOrganization.ps1 index 9380e9c0c..29f1386a6 100644 --- a/src/functions/public/Organization/New-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/New-GitHubOrganization.ps1 @@ -7,8 +7,8 @@ function New-GitHubOrganization { This function creates a new GitHub organization within the specified enterprise. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell New-GitHubOrganization -Enterprise 'my-enterprise' -Name 'my-org' -Owner 'user1' -BillingEmail 'billing@example.com' ``` ``` diff --git a/src/functions/public/Organization/Remove-GitHubOrganization.ps1 b/src/functions/public/Organization/Remove-GitHubOrganization.ps1 index 371f6f738..952796971 100644 --- a/src/functions/public/Organization/Remove-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Remove-GitHubOrganization.ps1 @@ -10,7 +10,7 @@ filter Remove-GitHubOrganization { regarding account deletion before using this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubOrganization -Name 'GitHub' ``` diff --git a/src/functions/public/Organization/Update-GitHubOrganization.ps1 b/src/functions/public/Organization/Update-GitHubOrganization.ps1 index 25ecd1dff..6110e5593 100644 --- a/src/functions/public/Organization/Update-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Update-GitHubOrganization.ps1 @@ -8,14 +8,14 @@ filter Update-GitHubOrganization { profile and member privileges. .EXAMPLE - ```pwsh + ```powershell Update-GitHubOrganization -Organization 'GitHub' -Description 'The official GitHub organization.' ``` Sets the description for the organization 'GitHub' to 'The official GitHub organization.'. .EXAMPLE - ```pwsh + ```powershell $param = @{ Organization = 'GitHub' MembersCanCreatePublicRepositories = $true diff --git a/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 b/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 index ed5932d1a..6629d07f1 100644 --- a/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 +++ b/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 @@ -22,7 +22,7 @@ filter Get-GitHubRateLimit { instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRateLimit ``` diff --git a/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 index 8bb0ced71..e978a6467 100644 --- a/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 @@ -37,14 +37,14 @@ filter Add-GitHubReleaseAsset { the old file before you can re-upload the new asset. .EXAMPLE - ```pwsh + ```powershell Add-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '7654321' -Path 'C:\Users\octocat\Downloads\hello-world.zip' ``` Gets the release assets for the release with the ID '1234567' for the repository 'octocat/hello-world'. .EXAMPLE - ```pwsh + ```powershell Add-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '7654321' -Path 'C:\Users\octocat\Projects\MyApp' ``` diff --git a/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 index 77ad658a9..4e0bb47d4 100644 --- a/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 @@ -10,28 +10,28 @@ filter Get-GitHubReleaseAsset { If a tag and name are provided, the specific named asset from the release with that tag is returned. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '1234567' ``` Gets the release asset with the ID '1234567' for the repository 'octocat/hello-world'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ReleaseID '7654321' ``` Gets all release assets for the release with the ID '7654321' for the repository 'octocat/hello-world'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ReleaseID '7654321' -Name 'example.zip' ``` Gets the release asset named 'example.zip' from the release with ID '7654321' for the repository 'octocat/hello-world'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Name 'example.zip' ``` diff --git a/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 index 6ca88ca80..8a831d6bb 100644 --- a/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 @@ -7,7 +7,7 @@ filter Remove-GitHubReleaseAsset { Delete a release asset .EXAMPLE - ```pwsh + ```powershell Remove-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '1234567' ``` diff --git a/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 index 6173a964e..291f2f7c6 100644 --- a/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 @@ -9,12 +9,12 @@ function Save-GitHubReleaseAsset { personal access tokens (classic) or OAuth tokens with the `repo` scope are required. .EXAMPLE - ```pwsh + ```powershell Save-GitHubReleaseAsset -Owner 'octocat' -Repository 'Hello-World' -ID '123456' -Path 'C:\Assets' ``` Output: - ```pwsh + ```powershell Directory: C:\Assets Mode LastWriteTime Length Name @@ -25,12 +25,12 @@ function Save-GitHubReleaseAsset { Downloads release asset ID '123456' from the 'Hello-World' repository owned by 'octocat' to the specified path. .EXAMPLE - ```pwsh + ```powershell Save-GitHubReleaseAsset -Owner 'octocat' -Repository 'Hello-World' -Tag 'v1.0.0' -Name 'binary.zip' -Path 'C:\Assets\app' -Expand -Force ``` Output: - ```pwsh + ```powershell Directory: C:\Assets\app Mode LastWriteTime Length Name @@ -43,7 +43,7 @@ function Save-GitHubReleaseAsset { to the specified path, overwriting existing files during download and extraction. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repository = 'Hello-World' diff --git a/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 index 8413b0bf2..f84ddcd45 100644 --- a/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 @@ -7,7 +7,7 @@ filter Update-GitHubReleaseAsset { Users with push access to the repository can edit a release asset. .EXAMPLE - ```pwsh + ```powershell Update-GitHubReleaseAsset -Owner 'octocat' -Repository 'hello-world' -ID '1234567' -Name 'new_asset_name' -Label 'new_asset_label' ``` diff --git a/src/functions/public/Releases/Get-GitHubRelease.ps1 b/src/functions/public/Releases/Get-GitHubRelease.ps1 index c70ca3045..f8d477141 100644 --- a/src/functions/public/Releases/Get-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Get-GitHubRelease.ps1 @@ -9,28 +9,28 @@ filter Get-GitHubRelease { Information about published releases are available to everyone. Only users with push access will receive listings for draft releases. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' ``` Gets the latest release for the repository 'hello-world' owned by 'octocat'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -AllVersions ``` Gets all releases for the repository 'hello-world' owned by 'octocat'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' ``` Gets the release with the tag 'v1.0.0' for the repository 'hello-world' owned by 'octocat'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -ID '1234567' ``` diff --git a/src/functions/public/Releases/New-GitHubRelease.ps1 b/src/functions/public/Releases/New-GitHubRelease.ps1 index 8e37e43ec..ebd213a63 100644 --- a/src/functions/public/Releases/New-GitHubRelease.ps1 +++ b/src/functions/public/Releases/New-GitHubRelease.ps1 @@ -11,21 +11,21 @@ filter New-GitHubRelease { and "[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)" for details. .EXAMPLE - ```pwsh + ```powershell New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Target 'main' -Notes 'Release notes' ``` Creates a release for the repository 'octocat/hello-world' on the 'main' branch with the tag 'v1.0.0'. .EXAMPLE - ```pwsh + ```powershell New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v0.9.0' -Name 'Beta Release' -Draft -Prerelease ``` Creates a draft prerelease for the repository 'octocat/hello-world' with the tag 'v0.9.0' using the default target branch ('main'). .EXAMPLE - ```pwsh + ```powershell New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v2.0.0' -Latest ``` @@ -33,14 +33,14 @@ filter New-GitHubRelease { Note that when using -Latest, you cannot use -Draft or -Prerelease as they are mutually exclusive. .EXAMPLE - ```pwsh + ```powershell New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.1.0' -GenerateReleaseNotes ``` Creates a release for the repository 'octocat/hello-world' with the tag 'v1.1.0' and automatically generates release notes based on commits since the previous release. .EXAMPLE - ```pwsh + ```powershell New-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.2.0' -DiscussionCategoryName 'Announcements' -Notes 'Major update with new features' ``` diff --git a/src/functions/public/Releases/New-GitHubReleaseNote.ps1 b/src/functions/public/Releases/New-GitHubReleaseNote.ps1 index b139bb467..f50d995ad 100644 --- a/src/functions/public/Releases/New-GitHubReleaseNote.ps1 +++ b/src/functions/public/Releases/New-GitHubReleaseNote.ps1 @@ -9,7 +9,7 @@ filter New-GitHubReleaseNote { The generated release notes are not saved anywhere. They are intended to be generated and used when creating a new release. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repository = 'hello-world' @@ -23,7 +23,7 @@ filter New-GitHubReleaseNote { The configuration file '.github/release.yml' or '.github/release.yaml' will be used. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repository = 'hello-world' @@ -37,7 +37,7 @@ filter New-GitHubReleaseNote { In this example the tag 'v1.0.0' has to exist in the repository. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repository = 'hello-world' diff --git a/src/functions/public/Releases/Remove-GitHubRelease.ps1 b/src/functions/public/Releases/Remove-GitHubRelease.ps1 index e489ddbfe..ab7b47e81 100644 --- a/src/functions/public/Releases/Remove-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Remove-GitHubRelease.ps1 @@ -7,7 +7,7 @@ filter Remove-GitHubRelease { Users with push access to the repository can delete a release. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -ID '1234567' ``` diff --git a/src/functions/public/Releases/Set-GitHubRelease.ps1 b/src/functions/public/Releases/Set-GitHubRelease.ps1 index e7278cdc1..c920e9d7a 100644 --- a/src/functions/public/Releases/Set-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Set-GitHubRelease.ps1 @@ -16,35 +16,35 @@ filter Set-GitHubRelease { When using the 'Latest' parameter, the release will be promoted from draft/prerelease status to a full release. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Target 'main' -Notes 'Release notes' ``` Creates a new release with tag 'v1.0.0' targeting the 'main' branch. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Notes 'Updated release notes' ``` Updates an existing release with tag 'v1.0.0' to have new release notes. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Draft ``` Creates or updates a release as a draft release. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Prerelease ``` Creates or updates a release as a prerelease. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -Latest ``` @@ -52,14 +52,14 @@ filter Set-GitHubRelease { it will be promoted to a full release. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0.0' -GenerateReleaseNotes ``` Creates or updates a release with automatically generated release notes based on pull requests and commits. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepository -Owner 'octocat' -Repository 'hello-world' | Set-GitHubRelease -Tag 'v1.0.0' -Notes 'Release notes' ``` diff --git a/src/functions/public/Releases/Update-GitHubRelease.ps1 b/src/functions/public/Releases/Update-GitHubRelease.ps1 index c9d65d415..83090ec49 100644 --- a/src/functions/public/Releases/Update-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Update-GitHubRelease.ps1 @@ -10,21 +10,21 @@ filter Update-GitHubRelease { The function also accepts GitHubRelease objects through the pipeline. .EXAMPLE - ```pwsh + ```powershell Update-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -ID '1234567' -Notes 'Release notes' ``` Updates the release with the ID '1234567' for the repository 'octocat/hello-world' with the note 'Release notes'. .EXAMPLE - ```pwsh + ```powershell Update-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0' -Name 'Release v1.0' -Notes 'Stable release' ``` Updates the release with the tag 'v1.0' for the repository 'octocat/hello-world' with a new name and notes. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0' | Update-GitHubRelease -Draft:$false -Prerelease ``` @@ -32,7 +32,7 @@ filter Update-GitHubRelease { Gets a release by tag and updates it to be a prerelease (not a draft). .EXAMPLE - ```pwsh + ```powershell Update-GitHubRelease -Owner 'octocat' -Repository 'hello-world' -Tag 'v1.0' -Latest -GenerateReleaseNotes ``` diff --git a/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 index 93c4367de..6605821ab 100644 --- a/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 @@ -9,14 +9,14 @@ filter Get-GitHubRepositoryAutolink { Information about autolinks are only available to repository administrators. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' ``` Gets all autolinks for the repository 'Hello-World' owned by 'octocat'. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' -ID 1 ``` diff --git a/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 index fdf6f8ea6..9e7c64bc7 100644 --- a/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 @@ -7,7 +7,7 @@ filter New-GitHubRepositoryAutolink { Users with admin access to the repository can create an autolink. .EXAMPLE - ```pwsh + ```powershell New-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' -KeyPrefix 'GH-' -UrlTemplate 'https://www.example.com/issue/' ``` diff --git a/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 index 3121212a8..18d328c1f 100644 --- a/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 @@ -9,7 +9,7 @@ filter Remove-GitHubRepositoryAutolink { Information about autolinks are only available to repository administrators. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubRepositoryAutolink -Owner 'octocat' -Repository 'Hello-World' -AutolinkId 1 ``` diff --git a/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 b/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 index a74118485..695a22674 100644 --- a/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 +++ b/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubRepositoryCustomProperty { Users with read access to the repository can use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryCustomProperty -Owner 'octocat' -Repository 'hello-world' ``` diff --git a/src/functions/public/Repositories/Get-GitHubRepository.ps1 b/src/functions/public/Repositories/Get-GitHubRepository.ps1 index 43545dc6b..5da385798 100644 --- a/src/functions/public/Repositories/Get-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Get-GitHubRepository.ps1 @@ -11,35 +11,35 @@ filter Get-GitHubRepository { Can also be used with the name parameter to get a specific repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepository ``` Gets the repositories for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepository -Username 'octocat' ``` Gets the repositories for the specified user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepository -Organization 'github' -Name 'octocat' ``` Gets the specified repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepository -Organization 'github' -Team 'my-team' ``` Gets repositories that the 'my-team' team has access to in the `github` organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepository -Organization 'github' -Name 'octocat' -Team 'my-team' ``` diff --git a/src/functions/public/Repositories/Move-GitHubRepository.ps1 b/src/functions/public/Repositories/Move-GitHubRepository.ps1 index 09d0255ff..dceb15e60 100644 --- a/src/functions/public/Repositories/Move-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Move-GitHubRepository.ps1 @@ -12,7 +12,7 @@ filter Move-GitHubRepository { a fine-grained personal access token cannot be used because they are only granted access to a single account. .EXAMPLE - ```pwsh + ```powershell Move-GitHubRepository -Owner 'PSModule' -Name 'GitHub' -NewOwner 'GitHub' -NewName 'PowerShell' ``` diff --git a/src/functions/public/Repositories/New-GitHubRepository.ps1 b/src/functions/public/Repositories/New-GitHubRepository.ps1 index afd35acff..2f16be59c 100644 --- a/src/functions/public/Repositories/New-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/New-GitHubRepository.ps1 @@ -14,7 +14,7 @@ filter New-GitHubRepository { * `repo` scope to create a private repository .EXAMPLE - ```pwsh + ```powershell $params = @{ Name = 'Hello-World' Description = 'This is your first repository' @@ -37,7 +37,7 @@ filter New-GitHubRepository { Creates a new public repository named "Hello-World" owned by the authenticated user. .EXAMPLE - ```pwsh + ```powershell $params = @{ Organization = 'PSModule' Name = 'Hello-World' @@ -60,7 +60,7 @@ filter New-GitHubRepository { Creates a new public repository named "Hello-World" owned by the organization "PSModule". .EXAMPLE - ```pwsh + ```powershell $params = @{ TemplateOwner = 'GitHub' TemplateRepository = 'octocat' @@ -76,7 +76,7 @@ filter New-GitHubRepository { Creates a new private repository named `MyNewRepo` from the `octocat` template repository owned by `GitHub`. .EXAMPLE - ```pwsh + ```powershell $params = @{ ForkOwner = 'octocat' ForkRepo = 'Hello-World' diff --git a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 index f6aee0858..1f8703f71 100644 --- a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 @@ -7,19 +7,19 @@ filter Get-GitHubRepositoryPermission { Retrieves the permission level assigned to a specific team for a given GitHub repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryPermission -Owner 'octocat' -Name 'Hello-World' -Team 'core' ``` Output: - ```pwsh + ```powershell Admin ``` Retrieves the permission of the 'core' team on the 'Hello-World' repository owned by 'octocat'. .EXAMPLE - ```pwsh + ```powershell ``` diff --git a/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 index 236a2c2ba..e73407fea 100644 --- a/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 @@ -7,7 +7,7 @@ filter Remove-GitHubRepositoryPermission { This function removes a team's access to a specific repository within an organization. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubRepositoryPermission -Owner 'my-org' -Name 'repo-name' -Team 'dev-team' ``` diff --git a/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 index 4741459d0..aa683dd50 100644 --- a/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 @@ -9,7 +9,7 @@ filter Set-GitHubRepositoryPermission { 'None' is specified, the function removes the team's access to the repository. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRepositoryPermission -Owner 'MyOrg' -Name 'MyRepo' -Team 'devs' -Permission 'push' ``` diff --git a/src/functions/public/Repositories/Remove-GitHubRepository.ps1 b/src/functions/public/Repositories/Remove-GitHubRepository.ps1 index 3a085cde0..16ed92527 100644 --- a/src/functions/public/Repositories/Remove-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Remove-GitHubRepository.ps1 @@ -10,7 +10,7 @@ filter Remove-GitHubRepository { repositories, you will get a `403 Forbidden` response. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubRepository -Owner 'PSModule' -Name 'Hello-World' ``` diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 index b2c5b7012..91018c32e 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 @@ -9,7 +9,7 @@ filter Disable-GitHubRepositoryPrivateVulnerabilityReporting { "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)". .EXAMPLE - ```pwsh + ```powershell Disable-GitHubRepositoryPrivateVulnerabilityReporting -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 index a35a3cbc5..7d2051c27 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 @@ -9,7 +9,7 @@ filter Disable-GitHubRepositorySecurityFix { "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". .EXAMPLE - ```pwsh + ```powershell Disable-GitHubRepositorySecurityFix -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 index 0f2be001b..7dbf6d94f 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 @@ -9,7 +9,7 @@ filter Disable-GitHubRepositoryVulnerabilityAlert { "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". .EXAMPLE - ```pwsh + ```powershell Disable-GitHubRepositoryVulnerabilityAlert -Owner 'octocat' -Name 'hello-world' ``` diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 index 68a6cb9dc..a23ff4135 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 @@ -9,7 +9,7 @@ filter Enable-GitHubRepositoryPrivateVulnerabilityReporting { "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." .EXAMPLE - ```pwsh + ```powershell Enable-GitHubRepositoryPrivateVulnerabilityReporting -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 index 860d70490..cad08f16a 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 @@ -9,7 +9,7 @@ filter Enable-GitHubRepositorySecurityFix { "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". .EXAMPLE - ```pwsh + ```powershell Enable-GitHubRepositorySecurityFix -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 index 7e968ddcf..e348e86a9 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 @@ -10,7 +10,7 @@ filter Enable-GitHubRepositoryVulnerabilityAlert { "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". .EXAMPLE - ```pwsh + ```powershell Enable-GitHubRepositoryVulnerabilityAlert -Owner 'octocat' -Name 'hello-world' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 index 30aeebd97..80e981284 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 @@ -11,42 +11,42 @@ filter Get-GitHubRepositoryActivity { see "[Viewing activity and data for your repository](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' ``` .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Direction 'asc' ``` .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -PerPage 100 ``` .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Before '2021-01-01T00:00:00Z' ``` .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -After '2021-01-01T00:00:00Z' ``` .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Ref 'refs/heads/main' ``` .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -Actor 'octocat' ``` .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'PSModule' Repo = 'GitHub' @@ -59,7 +59,7 @@ filter Get-GitHubRepositoryActivity { Gets the activity for the past 24 hours and selects the actor, activity type, ref, and timestamp. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryActivity -Owner 'PSModule' -Name 'GitHub' -ActivityType 'push','force_push' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 index 306f22bd7..91e190e16 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 @@ -10,7 +10,7 @@ filter Get-GitHubRepositoryCodeownersError { see "[About code owners](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)." .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryCodeownersError -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 index 534c12f07..ae3301c9a 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 @@ -12,7 +12,7 @@ filter Get-GitHubRepositoryContributor { in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryContributor -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 index 5606a21a8..10011cf63 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubRepositoryFork { List forks of a named repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryFork -Owner 'octocat' -Name 'Hello-World' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 index cbc36f5c3..7a811eef8 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 @@ -8,7 +8,7 @@ filter Get-GitHubRepositoryLanguage { bytes of code written in that language. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryLanguage -Owner 'octocat' -Name 'hello-world' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 index da362f43c..1374df856 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubRepositorySecurityFix { "[Configuring automated security fixes](https://docs.github.com/articles/configuring-automated-security-fixes)". .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositorySecurityFix -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 index a411aaedd..f26e5503b 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubRepositoryTag { List repository tags .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryTag -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 index 4ae146075..488084bc7 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 @@ -15,7 +15,7 @@ filter Get-GitHubRepositoryTeam { This endpoint is not compatible with fine-grained personal access tokens. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryTeam -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 index 350e8e949..388b551cd 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 @@ -7,7 +7,7 @@ filter Get-GitHubRepositoryTopic { Get all repository topics .EXAMPLE - ```pwsh + ```powershell ``` .NOTES diff --git a/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 index c9d2e3611..b3af72fb3 100644 --- a/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 +++ b/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 @@ -7,7 +7,7 @@ filter Set-GitHubRepositoryTopic { Replace all repository topics .EXAMPLE - ```pwsh + ```powershell Set-GitHubRepositoryTopic -Owner 'octocat' -Name 'hello-world' -Topic 'octocat', 'octo', 'octocat/hello-world' ``` diff --git a/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 b/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 index 21327b620..7ecf7b212 100644 --- a/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 +++ b/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 @@ -25,7 +25,7 @@ filter Start-GitHubRepositoryEvent { This input example shows how you can use the `client_payload` as a test to debug your workflow. .EXAMPLE - ```pwsh + ```powershell $params = @{ EventType = 'on-demand-test' ClientPayload = @{ diff --git a/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 index fc3212211..ae4d32734 100644 --- a/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 @@ -10,7 +10,7 @@ filter Test-GitHubRepositoryVulnerabilityAlert { "[About security alerts for vulnerable dependencies](https://docs.github.com/articles/about-security-alerts-for-vulnerable-dependencies)". .EXAMPLE - ```pwsh + ```powershell Test-GitHubRepositoryVulnerabilityAlert -Owner 'PSModule' -Name 'GitHub' ``` diff --git a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 index 1cd580fae..2d77f67ff 100644 --- a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 +++ b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 @@ -9,7 +9,7 @@ filter Get-GitHubRepositoryRuleSuite { For more information, see"[Managing rulesets for a repository](https://docs.github.com/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#viewing-insights-for-rulesets)." .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Repo = 'hello-world' @@ -24,7 +24,7 @@ filter Get-GitHubRepositoryRuleSuite { Gets a list of rule suites for the main branch of the hello-world repository owned by octocat. .EXAMPLE - ```pwsh + ```powershell Get-GitHubRepositoryRuleSuite -Owner 'octocat' -Repository 'hello-world' -RuleSuiteId 123456789 ``` diff --git a/src/functions/public/Repositories/Set-GitHubRepository.ps1 b/src/functions/public/Repositories/Set-GitHubRepository.ps1 index 9c6b45751..595d2670e 100644 --- a/src/functions/public/Repositories/Set-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Set-GitHubRepository.ps1 @@ -9,7 +9,7 @@ function Set-GitHubRepository { provided parameters. The updated or newly created repository is returned. .EXAMPLE - ```pwsh + ```powershell Set-GitHubRepository -Name 'Hello-World' -Description 'My repo' ``` @@ -17,7 +17,7 @@ function Set-GitHubRepository { or updates it if it already exists. The repository uses GitHub's default settings. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'octocat' Name = 'Hello-World' diff --git a/src/functions/public/Repositories/Update-GitHubRepository.ps1 b/src/functions/public/Repositories/Update-GitHubRepository.ps1 index 46068efed..f221cd902 100644 --- a/src/functions/public/Repositories/Update-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Update-GitHubRepository.ps1 @@ -8,15 +8,15 @@ filter Update-GitHubRepository { [Replace all repository topics](https://docs.github.com/rest/repos/repos#replace-all-repository-topics) endpoint. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Update-GitHubRepository -Name 'octocat' -Description 'Hello-World' -Homepage 'https://github.com' ``` ``` .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell $params = @{ Owner = 'octocat' Name = 'Hello-World' diff --git a/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 b/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 index e40af3428..6bcc7504a 100644 --- a/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 +++ b/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 @@ -7,21 +7,21 @@ function Get-GitHubPublicKey { Gets your public key, which you need to encrypt secrets. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKey ``` Gets a public key for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKey -Organization 'octocat' ``` Gets a public key for the 'octocat' organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubPublicKey -Owner 'octocat' -Repository 'hello-world' -Type 'codespaces' ``` diff --git a/src/functions/public/Secrets/Get-GitHubSecret.ps1 b/src/functions/public/Secrets/Get-GitHubSecret.ps1 index 00d65bd22..c727b5b94 100644 --- a/src/functions/public/Secrets/Get-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Get-GitHubSecret.ps1 @@ -11,21 +11,21 @@ function Get-GitHubSecret { The function returns an array of PSObjects containing metadata about the secrets. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecret -Owner PSModule -Repo Demo -Type actions ``` Retrieves all Actions secrets from the 'Demo' repository under the 'PSModule' organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecret -Owner PSModule -Type organization ``` Retrieves all organization-level secrets under the 'PSModule' organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecret -Owner PSModule -Repo Demo -Environment Staging ``` diff --git a/src/functions/public/Secrets/Remove-GitHubSecret.ps1 b/src/functions/public/Secrets/Remove-GitHubSecret.ps1 index bffacaa75..e93e67315 100644 --- a/src/functions/public/Secrets/Remove-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Remove-GitHubSecret.ps1 @@ -8,21 +8,21 @@ function Remove-GitHubSecret { Supports both Actions and Codespaces secrets and requires appropriate authentication. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubSecret -Owner PSModule -Repository Demo -Type actions -Name TEST ``` Deletes the secret named 'TEST' from the 'Demo' repository in the 'PSModule' organization. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubSecret -Organization MyOrg -Type actions -Name API_KEY ``` Deletes the secret 'API_KEY' from the organization 'MyOrg'. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubSecret -Owner MyUser -Repository MyRepo -Environment Production -Name DB_PASSWORD ``` diff --git a/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 index 1159f5557..3e9782ee4 100644 --- a/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 @@ -11,7 +11,7 @@ function Add-GitHubSecretSelectedRepository { and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Add-GitHubSecretSelectedRepository -Owner 'my-org' -Name 'API_KEY' -RepositoryID '654321' ``` diff --git a/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 index 3d3989bcd..33992634d 100644 --- a/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 @@ -9,12 +9,12 @@ function Get-GitHubSecretSelectedRepository { need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell Get-GitHubSecretSelectedRepository -Owner 'octocat' -Name 'hello-world' ``` Outputs: - ```pwsh + ```powershell Name : hello-world NodeID : m_MDXNcwMAwMMA ID : 123456789 diff --git a/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 index e46d9bccb..f27f1161d 100644 --- a/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 @@ -10,7 +10,7 @@ function Remove-GitHubSecretSelectedRepository { tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubSecretSelectedRepository -Owner 'my-org' -Name 'ENV_SECRET' -RepositoryID 123456 ``` diff --git a/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 index c013242d7..465335067 100644 --- a/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 @@ -10,7 +10,7 @@ function Set-GitHubSecretSelectedRepository { tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell Set-GitHubSecretSelectedRepository -Owner 'octocat' -Name 'mysecret' -RepositoryID 1234567890 ``` diff --git a/src/functions/public/Secrets/Set-GitHubSecret.ps1 b/src/functions/public/Secrets/Set-GitHubSecret.ps1 index 1963d8642..da67d831b 100644 --- a/src/functions/public/Secrets/Set-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Set-GitHubSecret.ps1 @@ -8,7 +8,7 @@ function Set-GitHubSecret { It encrypts the secret value before storing it and supports different visibility levels. .EXAMPLE - ```pwsh + ```powershell $secret = ConvertTo-SecureString "my-secret-value" -AsPlainText -Force Set-GitHubSecret -Repository 'MyRepo' -Owner 'MyUser' -Name 'MySecret' -Value $secret ``` @@ -16,7 +16,7 @@ function Set-GitHubSecret { Updates the secret `MySecret` in the `MyRepo` repository for the owner `MyUser`. .EXAMPLE - ```pwsh + ```powershell $params = @{ Organization = 'MyOrg' Name = 'MySecret' @@ -30,7 +30,7 @@ function Set-GitHubSecret { Updates the secret `MySecret` at the organization level for GitHub Actions, setting visibility to private. .EXAMPLE - ```pwsh + ```powershell $params = @{ Owner = 'MyUser' Repository = 'MyRepo' diff --git a/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 b/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 index bdd856f94..d78da0f2a 100644 --- a/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 +++ b/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 @@ -13,7 +13,7 @@ function Get-GitHubScheduledMaintenance { Impact: None (black), Minor (yellow), Major (orange), or Critical (red) .EXAMPLE - ```pwsh + ```powershell Get-GitHubScheduledMaintenance ``` @@ -21,14 +21,14 @@ function Get-GitHubScheduledMaintenance { This includes scheduled maintenances as described in the above two endpoints, as well as those in the Completed state. .EXAMPLE - ```pwsh + ```powershell Get-GitHubScheduledMaintenance -Active ``` Get a list of any active maintenances. .EXAMPLE - ```pwsh + ```powershell Get-GitHubScheduledMaintenance -Upcoming ``` diff --git a/src/functions/public/Status/Get-GitHubStatus.ps1 b/src/functions/public/Status/Get-GitHubStatus.ps1 index 77154f4b5..5325d4948 100644 --- a/src/functions/public/Status/Get-GitHubStatus.ps1 +++ b/src/functions/public/Status/Get-GitHubStatus.ps1 @@ -11,14 +11,14 @@ function Get-GitHubStatus { and "Major Service Outage". .EXAMPLE - ```pwsh + ```powershell Get-GitHubStatus ``` Gets the status of GitHub services .EXAMPLE - ```pwsh + ```powershell Get-GitHubStatus -Summary ``` diff --git a/src/functions/public/Status/Get-GitHubStatusComponent.ps1 b/src/functions/public/Status/Get-GitHubStatusComponent.ps1 index 57316a565..be769e247 100644 --- a/src/functions/public/Status/Get-GitHubStatusComponent.ps1 +++ b/src/functions/public/Status/Get-GitHubStatusComponent.ps1 @@ -8,7 +8,7 @@ function Get-GitHubStatusComponent { degraded_performance, partial_outage, or major_outage. .EXAMPLE - ```pwsh + ```powershell Get-GitHubStatusComponent ``` diff --git a/src/functions/public/Status/Get-GitHubStatusIncident.ps1 b/src/functions/public/Status/Get-GitHubStatusIncident.ps1 index cc59a1dcb..6e7cad880 100644 --- a/src/functions/public/Status/Get-GitHubStatusIncident.ps1 +++ b/src/functions/public/Status/Get-GitHubStatusIncident.ps1 @@ -12,14 +12,14 @@ function Get-GitHubStatusIncident { Impact: None (black), Minor (yellow), Major (orange), or Critical (red) .EXAMPLE - ```pwsh + ```powershell Get-GitHubStatusIncident ``` Gets the status of GitHub incidents .EXAMPLE - ```pwsh + ```powershell Get-GitHubStatusIncident -Unresolved ``` diff --git a/src/functions/public/Teams/Get-GitHubTeam.ps1 b/src/functions/public/Teams/Get-GitHubTeam.ps1 index b986c69d7..71b414700 100644 --- a/src/functions/public/Teams/Get-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Get-GitHubTeam.ps1 @@ -9,21 +9,21 @@ function Get-GitHubTeam { and replaces spaces with a - separator. For example, "My TEam Näme" would become my-team-name. .EXAMPLE - ```pwsh + ```powershell Get-GitHubTeam -Organization 'GitHub' ``` Gets all teams in the `github` organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubTeam -Organization 'github' -Slug 'my-team-name' ``` Gets the team with the slug 'my-team-name' in the `github` organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubTeam -Organization 'github' -Repository 'my-repo' ``` diff --git a/src/functions/public/Teams/New-GitHubTeam.ps1 b/src/functions/public/Teams/New-GitHubTeam.ps1 index a3193a96a..3882993e3 100644 --- a/src/functions/public/Teams/New-GitHubTeam.ps1 +++ b/src/functions/public/Teams/New-GitHubTeam.ps1 @@ -13,7 +13,7 @@ function New-GitHubTeam { "[About teams](https://docs.github.com/github/setting-up-and-managing-organizations-and-teams/about-teams)". .EXAMPLE - ```pwsh + ```powershell $params = @{ Organization = 'github' Name = 'team-name' diff --git a/src/functions/public/Teams/Remove-GitHubTeam.ps1 b/src/functions/public/Teams/Remove-GitHubTeam.ps1 index 24168b13a..2defb769b 100644 --- a/src/functions/public/Teams/Remove-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Remove-GitHubTeam.ps1 @@ -8,7 +8,7 @@ function Remove-GitHubTeam { If you are an organization owner, deleting a parent team will delete all of its child teams as well. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubTeam -Organization 'github' -Name 'team-name' ``` diff --git a/src/functions/public/Teams/Update-GitHubTeam.ps1 b/src/functions/public/Teams/Update-GitHubTeam.ps1 index 4db8741f8..1600119ce 100644 --- a/src/functions/public/Teams/Update-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Update-GitHubTeam.ps1 @@ -7,7 +7,7 @@ function Update-GitHubTeam { To edit a team, the authenticated user must either be an organization owner or a team maintainer. .EXAMPLE - ```pwsh + ```powershell $params = @{ Organization = 'github' Slug = 'team-name' diff --git a/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 b/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 index 68ede73bc..2afa83c9b 100644 --- a/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 +++ b/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 @@ -8,7 +8,7 @@ filter Block-GitHubUser { If the user cannot be blocked false is returned. .EXAMPLE - ```pwsh + ```powershell Block-GitHubUser -Username 'octocat' ``` @@ -16,7 +16,7 @@ filter Block-GitHubUser { Returns $true if successful, $false if not. .EXAMPLE - ```pwsh + ```powershell Block-GitHubUser -Organization 'GitHub' -Username 'octocat' ``` diff --git a/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 index 01afcf0e5..8dad681be 100644 --- a/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 +++ b/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 @@ -7,14 +7,14 @@ filter Get-GitHubBlockedUser { List the users that are blocked on your personal account or a given organization. .EXAMPLE - ```pwsh + ```powershell Get-GitHubBlockedUser ``` Returns a list of users blocked by the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubBlockedUser -Organization 'github' ``` diff --git a/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 index 0ddb7e244..84332aa9c 100644 --- a/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 +++ b/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 @@ -8,7 +8,7 @@ filter Test-GitHubBlockedUser { Returns a 404 if the given user is not blocked, or if the given user account has been identified as spam by GitHub. .EXAMPLE - ```pwsh + ```powershell Test-GitHubBlockedUser -Username 'octocat' ``` @@ -16,7 +16,7 @@ filter Test-GitHubBlockedUser { Returns true if the user is blocked, false if not. .EXAMPLE - ```pwsh + ```powershell Test-GitHubBlockedUser -Organization 'github' -Username 'octocat' ``` diff --git a/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 b/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 index 22fdf56ec..d770801e2 100644 --- a/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 +++ b/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 @@ -7,7 +7,7 @@ filter Unblock-GitHubUser { Unblocks the given user and returns true. .EXAMPLE - ```pwsh + ```powershell Unblock-GitHubUser -Username 'octocat' ``` @@ -15,7 +15,7 @@ filter Unblock-GitHubUser { Returns $true if successful. .EXAMPLE - ```pwsh + ```powershell Unblock-GitHubUser -Organization 'GitHub' -Username 'octocat' ``` diff --git a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 index d03336ad9..6723ba8d3 100644 --- a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 @@ -7,8 +7,8 @@ filter Add-GitHubUserEmail { This endpoint is accessible with the `user` scope. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Add-GitHubUserEmail -Email 'octocat@github.com','firstname.lastname@work.com' ``` ``` diff --git a/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 index 7bf9caa3f..1e0c50e18 100644 --- a/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 @@ -9,14 +9,14 @@ filter Get-GitHubUserEmail { authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserEmail ``` Gets all email addresses for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserEmail -Public ``` diff --git a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 index bdb6b6349..4bef87f50 100644 --- a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 @@ -7,8 +7,8 @@ filter Remove-GitHubUserEmail { This endpoint is accessible with the `user` scope. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Remove-GitHubUserEmail -Emails 'octocat@github.com','firstname.lastname@work.com' ``` ``` diff --git a/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 b/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 index b40cc175d..6d51fd28b 100644 --- a/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 +++ b/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 @@ -7,14 +7,14 @@ filter Update-GitHubUserEmailVisibility { Sets the visibility for your primary email addresses. .EXAMPLE - ```pwsh + ```powershell Set-GitHubUserEmailVisibility -Visibility Public ``` Sets the visibility for your primary email addresses to public. .EXAMPLE - ```pwsh + ```powershell Set-GitHubUserEmailVisibility -Visibility Private ``` diff --git a/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 index 202e4392f..07a6c299a 100644 --- a/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 @@ -9,7 +9,7 @@ filter Add-GitHubUserFollowing { Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. .EXAMPLE - ```pwsh + ```powershell Follow-GitHubUser -Username 'octocat' ``` diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 index 00d2b6f4d..46a398005 100644 --- a/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 +++ b/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 @@ -7,14 +7,14 @@ filter Get-GitHubUserFollower { Lists the people following a given user or the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserFollower ``` Gets all followers of the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserFollower -Username 'octocat' ``` diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 index c9e79f81a..15b1cf866 100644 --- a/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 @@ -7,14 +7,14 @@ filter Get-GitHubUserFollowing { Lists the people who a given user or the authenticated user follows. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserFollowing ``` Gets all people the authenticated user follows. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserFollowing -Username 'octocat' ``` diff --git a/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 index b027317e1..6e603994e 100644 --- a/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 @@ -7,7 +7,7 @@ filter Remove-GitHubUserFollowing { Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. .EXAMPLE - ```pwsh + ```powershell Unfollow-GitHubUser -Username 'octocat' ``` diff --git a/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 index aa752587c..76a425855 100644 --- a/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 @@ -8,7 +8,7 @@ filter Test-GitHubUserFollowing { Returns a 404 if the user is not followed by a given user or the authenticated user. .EXAMPLE - ```pwsh + ```powershell Test-GitHubUserFollowing -Follows 'octocat' Test-GitHubUserFollowing 'octocat' ``` @@ -16,7 +16,7 @@ filter Test-GitHubUserFollowing { Checks if the authenticated user follows the user 'octocat'. .EXAMPLE - ```pwsh + ```powershell Test-GitHubUserFollowing -Username 'octocat' -Follows 'ratstallion' ``` diff --git a/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 index eb29fc957..fa91c5789 100644 --- a/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 @@ -9,7 +9,7 @@ filter Add-GitHubUserGpgKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Add-GitHubUserGpgKey -Name 'GPG key for GitHub' -ArmoredPublicKey @' -----BEGIN PGP PUBLIC KEY BLOCK----- Version: GnuPG v1 diff --git a/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 index 262ddeec3..d5512209c 100644 --- a/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 @@ -7,21 +7,21 @@ filter Get-GitHubUserGpgKey { Lists a given user's or the current user's GPG keys. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserGpgKey ``` Gets all GPG keys for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserGpgKey -ID '1234567' ``` Gets the GPG key with ID '1234567' for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserGpgKey -Username 'octocat' ``` diff --git a/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 index 92cbaf223..f0008b921 100644 --- a/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 @@ -9,7 +9,7 @@ filter Remove-GitHubUserGpgKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Remove-GitHubUserGpgKey -ID '1234567' ``` diff --git a/src/functions/public/Users/Get-GitHubUser.ps1 b/src/functions/public/Users/Get-GitHubUser.ps1 index 962004dba..36770cabb 100644 --- a/src/functions/public/Users/Get-GitHubUser.ps1 +++ b/src/functions/public/Users/Get-GitHubUser.ps1 @@ -9,21 +9,21 @@ function Get-GitHubUser { Lists all users, in the order that they signed up on GitHub - if '-All' is provided. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUser ``` Get the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUser -Name 'octocat' ``` Get the 'octocat' user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUser -All -Since 17722253 ``` diff --git a/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 index e83d793b6..d22420b55 100644 --- a/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 @@ -9,7 +9,7 @@ filter Add-GitHubUserKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Add-GitHubUserKey -Title 'ssh-rsa AAAAB3NzaC1yc2EAAA' -Key '2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234' ``` diff --git a/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 index 95b61850e..dee22e785 100644 --- a/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 @@ -10,21 +10,21 @@ filter Get-GitHubUserKey { Keys from a given user are accessible by anyone. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserKey ``` Gets all GPG keys for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserKey -ID '1234567' ``` Gets the public SSH key with the ID '1234567' for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserKey -Username 'octocat' ``` diff --git a/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 index 9954e433a..230816240 100644 --- a/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 @@ -9,7 +9,7 @@ filter Remove-GitHubUserKey { [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). .EXAMPLE - ```pwsh + ```powershell Remove-GitHubUserKey -ID '1234567' ``` diff --git a/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 index 49fe11e69..973c44391 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 @@ -10,7 +10,7 @@ filter Add-GitHubUserSigningKey { "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE - ```pwsh + ```powershell Add-GitHubUserSigningKey -Title 'ssh-rsa AAAAB3NzaC1yc2EAAA' -Key '2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234' ``` diff --git a/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 index 2e78e2262..f44592342 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 @@ -7,21 +7,21 @@ filter Get-GitHubUserSigningKey { Lists a given user's or the current user's SSH signing keys. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserSigningKey ``` Gets all SSH signing keys for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserSigningKey -ID '1234567' ``` Gets the SSH signing key with the ID '1234567' for the authenticated user. .EXAMPLE - ```pwsh + ```powershell Get-GitHubUserSigningKey -Username 'octocat' ``` diff --git a/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 index d6080c132..123608b6d 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 @@ -10,7 +10,7 @@ filter Remove-GitHubUserSigningKey { "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." .EXAMPLE - ```pwsh + ```powershell Remove-GitHubUserSigningKey -ID '1234567' ``` diff --git a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 index 0ccde45d3..0d57399cb 100644 --- a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 @@ -7,8 +7,8 @@ filter Add-GitHubUserSocial { Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Add-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount', 'https://www.linkedin.com/company/MyCompany' ``` ``` diff --git a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 index 9b8513add..071cde62c 100644 --- a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 @@ -7,8 +7,8 @@ filter Remove-GitHubUserSocial { Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Remove-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount' ``` ``` diff --git a/src/functions/public/Users/Update-GitHubUser.ps1 b/src/functions/public/Users/Update-GitHubUser.ps1 index 461d07c7a..4a8997d03 100644 --- a/src/functions/public/Users/Update-GitHubUser.ps1 +++ b/src/functions/public/Users/Update-GitHubUser.ps1 @@ -9,21 +9,21 @@ filter Update-GitHubUser { displayed on your public profile or via the API. .EXAMPLE - ```pwsh + ```powershell Update-GitHubUser -Name 'octocat' ``` Update the authenticated user's name to 'octocat' .EXAMPLE - ```pwsh + ```powershell Update-GitHubUser -Location 'San Francisco' ``` Update the authenticated user's location to 'San Francisco' .EXAMPLE - ```pwsh + ```powershell Update-GitHubUser -Hireable $true -Description 'I love programming' ``` diff --git a/src/functions/public/Variables/Export-GitHubVariable.ps1 b/src/functions/public/Variables/Export-GitHubVariable.ps1 index c7393fb86..83af9b303 100644 --- a/src/functions/public/Variables/Export-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Export-GitHubVariable.ps1 @@ -12,7 +12,7 @@ function Export-GitHubVariable { The function accepts pipeline input, allowing GitHub variables retrieved using `Get-GitHubVariable` to be exported seamlessly. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'staging' | Export-GitHubVariable ``` diff --git a/src/functions/public/Variables/Get-GitHubVariable.ps1 b/src/functions/public/Variables/Get-GitHubVariable.ps1 index 9b5ee9bf1..6006e3e0c 100644 --- a/src/functions/public/Variables/Get-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Get-GitHubVariable.ps1 @@ -11,12 +11,12 @@ function Get-GitHubVariable { `admin:org` for organizations, and collaborator access for environments. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' ``` Output: - ```pwsh + ```powershell Name : HOST_NAME Value : github.com Owner : octocat @@ -27,12 +27,12 @@ function Get-GitHubVariable { Retrieves the specified variable from the organization level. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'GUID' ``` Output: - ```pwsh + ```powershell Name : GUID Value : 354aa0b0-65b1-46c8-9c3e-1576f4167a41 Owner : octocat @@ -43,12 +43,12 @@ function Get-GitHubVariable { Retrieves the specified variable from the repository level. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'DB_SERVER' ``` Output: - ```pwsh + ```powershell Name : DB_SERVER Value : db.example.com Owner : octocat @@ -59,12 +59,12 @@ function Get-GitHubVariable { Retrieves the specified variable from the environment level within a repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' ``` Output: - ```pwsh + ```powershell Name : MAX_THREADS Value : 10 Owner : octocat @@ -81,12 +81,12 @@ function Get-GitHubVariable { Retrieves all variables available at the organization level. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' ``` Output: - ```pwsh + ```powershell Name : LOG_LEVEL Value : INFO Owner : octocat @@ -103,12 +103,12 @@ function Get-GitHubVariable { Retrieves all variables available at the repository level. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'staging' ``` Output: - ```pwsh + ```powershell Name : CACHE_DURATION Value : 3600 Owner : octocat diff --git a/src/functions/public/Variables/New-GitHubVariable.ps1 b/src/functions/public/Variables/New-GitHubVariable.ps1 index b678d7515..a4bb5a00b 100644 --- a/src/functions/public/Variables/New-GitHubVariable.ps1 +++ b/src/functions/public/Variables/New-GitHubVariable.ps1 @@ -13,14 +13,14 @@ function New-GitHubVariable { - Environment-level variables require collaborator access to the repository. .EXAMPLE - ```pwsh + ```powershell New-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` Creates a new repository variable named `HOST_NAME` with the value `github.com` in the specified repository. .EXAMPLE - ```pwsh + ```powershell New-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Visibility 'all' -Context $GitHubContext ``` @@ -28,7 +28,7 @@ function New-GitHubVariable { makes it available to all repositories in the organization. .EXAMPLE - ```pwsh + ```powershell New-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` diff --git a/src/functions/public/Variables/Remove-GitHubVariable.ps1 b/src/functions/public/Variables/Remove-GitHubVariable.ps1 index 0a07712f2..e0cb2cd7a 100644 --- a/src/functions/public/Variables/Remove-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Remove-GitHubVariable.ps1 @@ -14,21 +14,21 @@ function Remove-GitHubVariable { - `repo` for repository and environment-level variables. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' | Remove-GitHubVariable ``` Removes all variables retrieved from the specified repository. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Context $GitHubContext ``` Deletes the specified variable from the specified organization. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubVariable -Variable $variablesArray ``` diff --git a/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 index fdc6dcdf3..884f788c0 100644 --- a/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 @@ -11,7 +11,7 @@ function Add-GitHubVariableSelectedRepository { Fine-grained tokens must have 'Variables' organization permission (write) and 'Metadata' repository permission (read). .EXAMPLE - ```pwsh + ```powershell Add-GitHubVariableSelectedRepository -Owner 'my-org' -Name 'API_KEY' -RepositoryID '654321' ``` diff --git a/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 index 99ba140c5..5afbcedfe 100644 --- a/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 @@ -10,7 +10,7 @@ function Get-GitHubVariableSelectedRepository { the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell Get-GitHubVariableSelectedRepository -Owner 'PSModule' -Name 'SELECTEDVAR' ``` diff --git a/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 index 6fbe68998..f3b1dd656 100644 --- a/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 @@ -16,7 +16,7 @@ function Remove-GitHubVariableSelectedRepository { 'Metadata' repository permissions (read). .EXAMPLE - ```pwsh + ```powershell Remove-GitHubVariableSelectedRepository -Owner 'my-org' -Name 'ENV_SECRET' -RepositoryID 123456 ``` diff --git a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 index 2a0b85bfe..b75a0c309 100644 --- a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 @@ -10,7 +10,7 @@ function Set-GitHubVariableSelectedRepository { OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. .EXAMPLE - ```pwsh + ```powershell ``` .LINK diff --git a/src/functions/public/Variables/Set-GitHubVariable.ps1 b/src/functions/public/Variables/Set-GitHubVariable.ps1 index 9e9c79ec1..d2ab74d0a 100644 --- a/src/functions/public/Variables/Set-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Set-GitHubVariable.ps1 @@ -13,14 +13,14 @@ function Set-GitHubVariable { - Environment-level variables require collaborator access to the repository. .EXAMPLE - ```pwsh + ```powershell Set-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` Creates or updates a repository variable named `HOST_NAME` with the value `github.com` in the specified repository. .EXAMPLE - ```pwsh + ```powershell Set-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Visibility 'all' -Context $GitHubContext ``` @@ -28,7 +28,7 @@ function Set-GitHubVariable { makes it available to all repositories in the organization. .EXAMPLE - ```pwsh + ```powershell Set-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Value 'github.com' -Context $GitHubContext ``` diff --git a/src/functions/public/Variables/Update-GitHubVariable.ps1 b/src/functions/public/Variables/Update-GitHubVariable.ps1 index e6933f406..84deec91a 100644 --- a/src/functions/public/Variables/Update-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Update-GitHubVariable.ps1 @@ -12,21 +12,21 @@ function Update-GitHubVariable { and environment variables require collaborator access. .EXAMPLE - ```pwsh + ```powershell Update-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Name 'HOST_NAME' -Value 'github.com' ``` Updates the repository variable named `HOST_NAME` with the value `github.com` in the specified repository. .EXAMPLE - ```pwsh + ```powershell Update-GitHubVariable -Owner 'octocat' -Name 'HOST_NAME' -Value 'github.com' -Visibility 'private' ``` Updates the organization variable named `HOST_NAME` with the value `github.com`, making it private. .EXAMPLE - ```pwsh + ```powershell Update-GitHubVariable -Owner 'octocat' -Repository 'Hello-World' -Environment 'dev' -Name 'HOST_NAME' -Value 'github.com' ``` diff --git a/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 index 4a05e893a..4b9b0e9c7 100644 --- a/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 @@ -11,7 +11,7 @@ function Get-GitHubAppWebhookConfiguration { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppWebhookConfiguration ``` diff --git a/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 b/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 index 6cfeed1d2..5ebd6acee 100644 --- a/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 +++ b/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 @@ -10,14 +10,14 @@ function Get-GitHubAppWebhookDelivery { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppWebhookDelivery ``` Returns a list of webhook deliveries for the webhook for the authenticated app. .EXAMPLE - ```pwsh + ```powershell Get-GitHubAppWebhookDelivery -ID 123456 ``` diff --git a/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 b/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 index af6536b76..a01692b23 100644 --- a/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 +++ b/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 @@ -10,7 +10,7 @@ function Invoke-GitHubAppWebhookReDelivery { to access this endpoint. .EXAMPLE - ```pwsh + ```powershell Invoke-GitHubAppWebhookReDelivery -ID 12345 ``` diff --git a/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 b/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 index 469048eb5..934b6152b 100644 --- a/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 +++ b/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 @@ -10,24 +10,24 @@ function Test-GitHubWebhookSignature { timing attacks. The function returns a boolean indicating whether the signature is valid. .EXAMPLE - ```pwsh + ```powershell Test-GitHubWebhookSignature -Secret $env:WEBHOOK_SECRET -Body $Request.RawBody -Signature $Request.Headers['X-Hub-Signature-256'] ``` Output: - ```pwsh + ```powershell True ``` Validates the provided webhook payload against the HMAC SHA-256 signature using the given secret. .EXAMPLE - ```pwsh + ```powershell Test-GitHubWebhookSignature -Secret $env:WEBHOOK_SECRET -Request $Request ``` Output: - ```pwsh + ```powershell True ``` diff --git a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 index ce02e7fbd..17ae034bb 100644 --- a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 @@ -11,14 +11,14 @@ function Update-GitHubAppWebhookConfiguration { to access this endpoint. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Update-GitHubAppWebhookConfiguration -URL 'https://example.com' -ContentType 'json' -Secret 'mysecret' -EnableSsl ``` ``` Output: - ```pwsh + ```powershell ContentType: json UseSsl: True Secret: mysecret diff --git a/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 index fdedb8374..8ebdfe640 100644 --- a/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 @@ -8,7 +8,7 @@ filter Disable-GitHubWorkflow { For example, you could use `main.yaml`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh + ```powershell ``` .INPUTS diff --git a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 index 54767532f..963fdb544 100644 --- a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 @@ -10,8 +10,8 @@ filter Enable-GitHubWorkflow { OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 'main.yaml' ``` ``` @@ -19,8 +19,8 @@ filter Enable-GitHubWorkflow { Enables the workflow with the file name 'main.yaml' in the PSModule/GitHub repository. .EXAMPLE - ```pwsh - ```pwsh + ```powershell + ```powershell Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 161335 ``` ``` diff --git a/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 index 50cec1390..dfa6d607e 100644 --- a/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 @@ -9,14 +9,14 @@ filter Get-GitHubWorkflow { GitHub Apps must have the actions:read permission to use this endpoint. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflow -Owner 'octocat' -Repository 'hello-world' ``` Gets all workflows in the 'octocat/hello-world' repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflow -Owner 'octocat' -Repository 'hello-world' -Name 'hello-world.yml' ``` diff --git a/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 index 0e1660d7b..417c1f452 100644 --- a/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 @@ -12,28 +12,28 @@ filter Get-GitHubWorkflowRun { `event`, `head_sha`, `status`. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRun -Owner 'owner' -Repository 'repo' ``` Lists all workflow runs for a repository. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRun -Owner 'owner' -Repository 'repo' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' ``` Lists all workflow runs for a repository with the specified actor, branch, event, and status. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -ID '42' ``` Gets all workflow runs for the workflow with the ID `42` in the repository `Hello-World` owned by `octocat`. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -Name 'nightly.yml' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success' ``` diff --git a/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 index 64bfe10f5..5284787eb 100644 --- a/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 @@ -9,7 +9,7 @@ filter Remove-GitHubWorkflowRun { this endpoint. .EXAMPLE - ```pwsh + ```powershell Remove-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -ID 123456789 ``` diff --git a/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 index 15345b313..05012b2b3 100644 --- a/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 @@ -7,7 +7,7 @@ filter Restart-GitHubWorkflowRun { Re-runs your workflow run using its `run_id`. You can also specify a branch or tag name to re-run a workflow run from a branch .EXAMPLE - ```pwsh + ```powershell Start-GitHubWorkflowReRun -Owner 'octocat' -Repository 'Hello-World' -ID 123456789 ``` diff --git a/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 index 547c4cfd7..24086a6f8 100644 --- a/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 @@ -7,7 +7,7 @@ filter Stop-GitHubWorkflowRun { Cancels a workflow run using its `run_id`. You can use this endpoint to cancel a workflow run that is in progress or waiting .EXAMPLE - ```pwsh + ```powershell Stop-GitHubWorkflowRun -Owner 'octocat' -Repository 'Hello-World' -ID 123456789 ``` diff --git a/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 index 9bf684258..ce800e80f 100644 --- a/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 @@ -7,7 +7,7 @@ filter Start-GitHubWorkflow { Start a workflow run using the workflow's ID. .EXAMPLE - ```pwsh + ```powershell Get-GitHubWorkflow | Where-Object name -NotLike '.*' | Start-GitHubWorkflow -Inputs @{ staticValidation = $true deploymentValidation = $false diff --git a/tools/utilities/New-Function.ps1 b/tools/utilities/New-Function.ps1 index 02ce6c3ec..088c628a3 100644 --- a/tools/utilities/New-Function.ps1 +++ b/tools/utilities/New-Function.ps1 @@ -7,7 +7,7 @@ Long description .EXAMPLE - ```pwsh + ```powershell New-Function -Path '/user/emails' -Method 'POST' ``` diff --git a/tools/utilities/New-FunctionTemplate.ps1 b/tools/utilities/New-FunctionTemplate.ps1 index d0be8ebda..7823e2ea9 100644 --- a/tools/utilities/New-FunctionTemplate.ps1 +++ b/tools/utilities/New-FunctionTemplate.ps1 @@ -7,7 +7,7 @@ function New-FunctionTemplate { Long description .EXAMPLE - ```pwsh + ```powershell An example ``` From 241538288dca4936a0853eab5068f53324a70473 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 12:33:43 +0200 Subject: [PATCH 10/16] Convert to UTF8withBom --- src/classes/public/GitHubPermission.ps1 | 2 +- src/functions/private/Actions/Import-GitHubEventData.ps1 | 2 +- src/functions/private/Actions/Import-GitHubRunnerData.ps1 | 2 +- .../Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 | 2 +- .../Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 | 2 +- .../private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 | 2 +- .../private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 | 2 +- .../Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 | 2 +- src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 | 2 +- .../Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 | 2 +- .../Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 | 2 +- .../Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 | 2 +- .../Get-GitHubAppInstallationForEnterpriseOrganization.ps1 | 2 +- .../GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 | 2 +- .../GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 | 2 +- .../private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 | 2 +- .../private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 | 2 +- .../private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 | 2 +- .../GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 | 2 +- src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 | 2 +- src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 | 2 +- .../private/Artifacts/Get-GitHubArtifactFromRepository.ps1 | 2 +- .../private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 | 2 +- src/functions/private/Auth/Cli/Connect-GithubCli.ps1 | 2 +- src/functions/private/Auth/Context/Assert-GitHubContext.ps1 | 2 +- src/functions/private/Auth/Context/Remove-GitHubContext.ps1 | 2 +- src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 | 2 +- .../private/Auth/Context/Resolve-GitHubContextSetting.ps1 | 2 +- src/functions/private/Auth/Context/Set-GitHubContext.ps1 | 2 +- .../private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 | 2 +- .../private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 | 2 +- .../private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 | 2 +- .../Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 | 2 +- .../private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 | 2 +- .../private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 | 2 +- src/functions/private/Auth/Get-GitHubToken.ps1 | 2 +- src/functions/private/Auth/Test-GitHubToken.ps1 | 2 +- src/functions/private/Branches/Get-GitHubBranchList.ps1 | 2 +- src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 | 2 +- src/functions/private/Config/Initialize-GitHubConfig.ps1 | 2 +- src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 | 2 +- src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 | 2 +- src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 | 2 +- .../private/Environments/Get-GitHubEnvironmentByName.ps1 | 2 +- .../private/Environments/Get-GitHubEnvironmentList.ps1 | 2 +- src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 | 2 +- src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 | 2 +- src/functions/private/License/Get-GitHubLicenseByName.ps1 | 2 +- src/functions/private/License/Get-GitHubLicenseList.ps1 | 2 +- src/functions/private/License/Get-GitHubRepositoryLicense.ps1 | 2 +- .../Organization/Blocking/Block-GitHubUserByOrganization.ps1 | 2 +- .../Blocking/Get-GitHubBlockedUserByOrganization.ps1 | 2 +- .../Blocking/Test-GitHubBlockedUserByOrganization.ps1 | 2 +- .../Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 | 2 +- .../private/Organization/Get-GitHubAllOrganization.ps1 | 2 +- .../private/Organization/Get-GitHubOrganizationByName.ps1 | 2 +- .../Organization/Get-GitHubOrganizationListForAuthUser.ps1 | 2 +- .../private/Organization/Get-GitHubUserOrganization.ps1 | 2 +- .../private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 | 2 +- .../Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 | 2 +- .../private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 | 2 +- .../Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 | 2 +- src/functions/private/Releases/Get-GitHubReleaseAll.ps1 | 2 +- src/functions/private/Releases/Get-GitHubReleaseByID.ps1 | 2 +- src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 | 2 +- src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 | 2 +- .../Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 | 2 +- .../Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 | 2 +- src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 | 2 +- .../private/Repositories/Get-GitHubMyRepositoryByName.ps1 | 2 +- .../private/Repositories/Get-GitHubRepositoryByName.ps1 | 2 +- .../private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 | 2 +- .../private/Repositories/Get-GitHubRepositoryListByOwner.ps1 | 2 +- .../private/Repositories/Get-GitHubRepositoryListByTeam.ps1 | 2 +- .../private/Repositories/New-GitHubRepositoryAsFork.ps1 | 2 +- .../private/Repositories/New-GitHubRepositoryFromTemplate.ps1 | 2 +- src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 | 2 +- src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 | 2 +- .../RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 | 2 +- .../RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 | 2 +- .../private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 | 2 +- .../private/Secrets/Get-GitHubSecretEnvironmentList.ps1 | 2 +- .../private/Secrets/Get-GitHubSecretFromOrganization.ps1 | 2 +- src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 | 2 +- src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 | 2 +- .../private/Secrets/Get-GitHubSecretRepositoryByName.ps1 | 2 +- .../private/Secrets/Get-GitHubSecretRepositoryList.ps1 | 2 +- .../PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 | 2 +- .../PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 | 2 +- .../PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 | 2 +- .../Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 | 2 +- .../PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 | 2 +- .../PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 | 2 +- .../private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 | 2 +- src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 | 2 +- .../private/Secrets/Remove-GitHubSecretFromRepository.ps1 | 2 +- src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 | 2 +- src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 | 2 +- src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 | 2 +- src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 | 2 +- src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 | 2 +- src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 | 2 +- src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 | 2 +- .../private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 | 2 +- .../private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 | 2 +- .../private/Users/Blocking/Unblock-GitHubUserByUser.ps1 | 2 +- src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 | 2 +- .../private/Users/Emails/Get-GitHubUserPublicEmail.ps1 | 2 +- .../private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 | 2 +- .../private/Users/Followers/Get-GitHubUserFollowingMe.ps1 | 2 +- .../private/Users/Followers/Get-GitHubUserFollowingUser.ps1 | 2 +- .../private/Users/Followers/Get-GitHubUserMyFollower.ps1 | 2 +- .../private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 | 2 +- .../private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 | 2 +- .../private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 | 2 +- src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 | 2 +- .../private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 | 2 +- src/functions/private/Users/Get-GitHubAllUser.ps1 | 2 +- src/functions/private/Users/Get-GitHubMyUser.ps1 | 2 +- src/functions/private/Users/Get-GitHubUserByName.ps1 | 2 +- src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 | 2 +- src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 | 2 +- src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 | 2 +- .../Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 | 2 +- .../Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 | 2 +- .../Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 | 2 +- .../private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 | 2 +- .../Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 | 2 +- .../private/Utilities/PowerShell/Get-FunctionParameter.ps1 | 2 +- .../private/Utilities/PowerShell/Get-PSCallStackPath.ps1 | 2 +- .../private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 | 2 +- .../private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 | 2 +- .../private/Variables/Get-GitHubVariableEnvironmentByName.ps1 | 2 +- .../private/Variables/Get-GitHubVariableEnvironmentList.ps1 | 2 +- .../private/Variables/Get-GitHubVariableFromOrganization.ps1 | 2 +- .../private/Variables/Get-GitHubVariableOwnerByName.ps1 | 2 +- src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 | 2 +- .../private/Variables/Get-GitHubVariableRepositoryByName.ps1 | 2 +- .../private/Variables/Get-GitHubVariableRepositoryList.ps1 | 2 +- .../private/Variables/New-GitHubVariableOnEnvironment.ps1 | 2 +- src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 | 2 +- .../private/Variables/New-GitHubVariableOnRepository.ps1 | 2 +- .../private/Variables/Remove-GitHubVariableFromEnvironment.ps1 | 2 +- .../private/Variables/Remove-GitHubVariableFromOwner.ps1 | 2 +- .../private/Variables/Remove-GitHubVariableFromRepository.ps1 | 2 +- .../private/Variables/Update-GitHubVariableOnEnvironment.ps1 | 2 +- .../private/Variables/Update-GitHubVariableOnOwner.ps1 | 2 +- .../private/Variables/Update-GitHubVariableOnRepository.ps1 | 2 +- .../private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 | 2 +- .../private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 | 2 +- .../Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 | 2 +- src/functions/public/API/Invoke-GitHubAPI.ps1 | 2 +- src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 | 2 +- src/functions/public/Actions/Data/Get-GitHubEventData.ps1 | 2 +- src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 | 2 +- .../Add-GitHubAppInstallationRepositoryAccess.ps1 | 2 +- .../Get-GitHubAppAccessibleRepository.ps1 | 2 +- .../Get-GitHubAppInstallationRepositoryAccess.ps1 | 2 +- .../New-GitHubAppInstallationAccessToken.ps1 | 2 +- .../Remove-GitHubAppInstallationRepositoryAccess.ps1 | 2 +- .../Update-GitHubAppInstallationRepositoryAccess.ps1 | 2 +- src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 | 2 +- .../public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 | 2 +- src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 | 2 +- src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 | 2 +- src/functions/public/Artifacts/Get-GitHubArtifact.ps1 | 2 +- src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 | 2 +- src/functions/public/Artifacts/Save-GitHubArtifact.ps1 | 2 +- src/functions/public/Auth/Connect-GitHubAccount.ps1 | 2 +- src/functions/public/Auth/Connect-GitHubApp.ps1 | 2 +- src/functions/public/Auth/Context/Get-GitHubContext.ps1 | 2 +- src/functions/public/Auth/Context/Switch-GitHubContext.ps1 | 2 +- src/functions/public/Auth/Disconnect-GitHubAccount.ps1 | 2 +- src/functions/public/Auth/Get-GitHubAccessToken.ps1 | 2 +- src/functions/public/Auth/Get-GitHubViewer.ps1 | 2 +- src/functions/public/Commands/Add-GitHubMask.ps1 | 2 +- src/functions/public/Commands/Add-GitHubSystemPath.ps1 | 2 +- src/functions/public/Commands/Disable-GitHubCommand.ps1 | 2 +- src/functions/public/Commands/Enable-GitHubCommand.ps1 | 2 +- src/functions/public/Commands/Get-GitHubOutput.ps1 | 2 +- src/functions/public/Commands/Reset-GitHubOutput.ps1 | 2 +- src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 | 2 +- src/functions/public/Commands/Set-GitHubLogGroup.ps1 | 2 +- src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 | 2 +- src/functions/public/Commands/Set-GitHubOutput.ps1 | 2 +- src/functions/public/Commands/Set-GitHubStepSummary.ps1 | 2 +- src/functions/public/Commands/Start-GitHubLogGroup.ps1 | 2 +- src/functions/public/Commands/Stop-GitHubLogGroup.ps1 | 2 +- src/functions/public/Commands/Write-GitHubDebug.ps1 | 2 +- src/functions/public/Commands/Write-GitHubError.ps1 | 2 +- src/functions/public/Commands/Write-GitHubLog.ps1 | 2 +- src/functions/public/Commands/Write-GitHubNotice.ps1 | 2 +- src/functions/public/Commands/Write-GitHubWarning.ps1 | 2 +- src/functions/public/Config/Get-GitHubConfig.ps1 | 2 +- src/functions/public/Config/Remove-GitHubConfig.ps1 | 2 +- src/functions/public/Config/Reset-GitHubConfig.ps1 | 2 +- src/functions/public/Config/Set-GitHubConfig.ps1 | 2 +- src/functions/public/Emojis/Get-GitHubEmoji.ps1 | 2 +- src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 | 2 +- .../public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 | 2 +- src/functions/public/Environments/Get-GitHubEnvironment.ps1 | 2 +- src/functions/public/Environments/Remove-GitHubEnvironment.ps1 | 2 +- src/functions/public/Environments/Set-GitHubEnvironment.ps1 | 2 +- src/functions/public/Git/Get-GitHubGitConfig.ps1 | 2 +- src/functions/public/Git/Set-GitHubGitConfig.ps1 | 2 +- src/functions/public/Gitignore/Get-GitHubGitignore.ps1 | 2 +- src/functions/public/Issues/ConvertFrom-IssueForm.ps1 | 2 +- src/functions/public/License/Get-GitHubLicense.ps1 | 2 +- src/functions/public/Markdown/Get-GitHubMarkdown.ps1 | 2 +- src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 | 2 +- src/functions/public/Meta/Get-GitHubApiVersion.ps1 | 2 +- src/functions/public/Meta/Get-GitHubMeta.ps1 | 2 +- src/functions/public/Meta/Get-GitHubOctocat.ps1 | 2 +- src/functions/public/Meta/Get-GitHubRoot.ps1 | 2 +- src/functions/public/Meta/Get-GitHubZen.ps1 | 2 +- src/functions/public/Organization/Get-GitHubOrganization.ps1 | 2 +- .../Members/Get-GitHubOrganizationPendingInvitation.ps1 | 2 +- .../Organization/Members/New-GitHubOrganizationInvitation.ps1 | 2 +- .../Members/Remove-GitHubOrganizationInvitation.ps1 | 2 +- src/functions/public/Organization/New-GitHubOrganization.ps1 | 2 +- src/functions/public/Organization/Remove-GitHubOrganization.ps1 | 2 +- src/functions/public/Organization/Update-GitHubOrganization.ps1 | 2 +- src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 | 2 +- src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 | 2 +- src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 | 2 +- .../public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 | 2 +- .../public/Releases/Assets/Save-GitHubReleaseAsset.ps1 | 2 +- .../public/Releases/Assets/Update-GitHubReleaseAsset.ps1 | 2 +- src/functions/public/Releases/Get-GitHubRelease.ps1 | 2 +- src/functions/public/Releases/New-GitHubRelease.ps1 | 2 +- src/functions/public/Releases/New-GitHubReleaseNote.ps1 | 2 +- src/functions/public/Releases/Remove-GitHubRelease.ps1 | 2 +- src/functions/public/Releases/Set-GitHubRelease.ps1 | 2 +- src/functions/public/Releases/Update-GitHubRelease.ps1 | 2 +- .../Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 | 2 +- .../Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 | 2 +- .../Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 | 2 +- .../CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 | 2 +- src/functions/public/Repositories/Get-GitHubRepository.ps1 | 2 +- src/functions/public/Repositories/Move-GitHubRepository.ps1 | 2 +- src/functions/public/Repositories/New-GitHubRepository.ps1 | 2 +- .../Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 | 2 +- .../Permissions/Remove-GitHubRepositoryPermission.ps1 | 2 +- .../Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 | 2 +- src/functions/public/Repositories/Remove-GitHubRepository.ps1 | 2 +- .../Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 | 2 +- .../Repositories/Disable-GitHubRepositorySecurityFix.ps1 | 2 +- .../Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 | 2 +- .../Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 | 2 +- .../Repositories/Enable-GitHubRepositorySecurityFix.ps1 | 2 +- .../Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 | 2 +- .../Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 | 2 +- .../Repositories/Get-GitHubRepositoryCodeownersError.ps1 | 2 +- .../Repositories/Get-GitHubRepositoryContributor.ps1 | 2 +- .../Repositories/Repositories/Get-GitHubRepositoryFork.ps1 | 2 +- .../Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 | 2 +- .../Repositories/Get-GitHubRepositorySecurityFix.ps1 | 2 +- .../Repositories/Repositories/Get-GitHubRepositoryTag.ps1 | 2 +- .../Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 | 2 +- .../Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 | 2 +- .../Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 | 2 +- .../Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 | 2 +- .../Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 | 2 +- .../Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 | 2 +- src/functions/public/Repositories/Set-GitHubRepository.ps1 | 2 +- src/functions/public/Repositories/Update-GitHubRepository.ps1 | 2 +- src/functions/public/Secrets/Get-GitHubPublicKey.ps1 | 2 +- src/functions/public/Secrets/Get-GitHubSecret.ps1 | 2 +- src/functions/public/Secrets/Remove-GitHubSecret.ps1 | 2 +- .../SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 | 2 +- .../SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 | 2 +- .../Remove-GitHubSecretSelectedRepository.ps1 | 2 +- .../SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 | 2 +- src/functions/public/Secrets/Set-GitHubSecret.ps1 | 2 +- src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 | 2 +- src/functions/public/Status/Get-GitHubStatus.ps1 | 2 +- src/functions/public/Status/Get-GitHubStatusComponent.ps1 | 2 +- src/functions/public/Status/Get-GitHubStatusIncident.ps1 | 2 +- src/functions/public/Teams/Get-GitHubTeam.ps1 | 2 +- src/functions/public/Teams/New-GitHubTeam.ps1 | 2 +- src/functions/public/Teams/Remove-GitHubTeam.ps1 | 2 +- src/functions/public/Teams/Update-GitHubTeam.ps1 | 2 +- src/functions/public/Users/Blocking/Block-GitHubUser.ps1 | 2 +- src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 | 2 +- src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 | 2 +- src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 | 2 +- src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 | 2 +- src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 | 2 +- src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 | 2 +- .../public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 | 2 +- .../public/Users/Followers/Add-GitHubUserFollowing.ps1 | 2 +- src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 | 2 +- .../public/Users/Followers/Get-GitHubUserFollowing.ps1 | 2 +- .../public/Users/Followers/Remove-GitHubUserFollowing.ps1 | 2 +- .../public/Users/Followers/Test-GitHubUserFollowing.ps1 | 2 +- src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 | 2 +- src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 | 2 +- src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 | 2 +- src/functions/public/Users/Get-GitHubUser.ps1 | 2 +- src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 | 2 +- src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 | 2 +- src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 | 2 +- .../public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 | 2 +- .../public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 | 2 +- .../Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 | 2 +- .../public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 | 2 +- .../public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 | 2 +- src/functions/public/Users/Update-GitHubUser.ps1 | 2 +- src/functions/public/Variables/Export-GitHubVariable.ps1 | 2 +- src/functions/public/Variables/Get-GitHubVariable.ps1 | 2 +- src/functions/public/Variables/New-GitHubVariable.ps1 | 2 +- src/functions/public/Variables/Remove-GitHubVariable.ps1 | 2 +- .../SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 | 2 +- .../SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 | 2 +- .../Remove-GitHubVariableSelectedRepository.ps1 | 2 +- .../SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 | 2 +- src/functions/public/Variables/Set-GitHubVariable.ps1 | 2 +- src/functions/public/Variables/Update-GitHubVariable.ps1 | 2 +- .../public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 | 2 +- src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 | 2 +- .../public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 | 2 +- src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 | 2 +- .../public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 | 2 +- src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 | 2 +- src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 | 2 +- src/functions/public/Workflows/Get-GitHubWorkflow.ps1 | 2 +- src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 | 2 +- .../public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 | 2 +- .../public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 | 2 +- src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 | 2 +- src/functions/public/Workflows/Start-GitHubWorkflow.ps1 | 2 +- tools/utilities/New-FunctionTemplate.ps1 | 2 +- 332 files changed, 332 insertions(+), 332 deletions(-) diff --git a/src/classes/public/GitHubPermission.ps1 b/src/classes/public/GitHubPermission.ps1 index 3a0d6d9ce..c3f07529d 100644 --- a/src/classes/public/GitHubPermission.ps1 +++ b/src/classes/public/GitHubPermission.ps1 @@ -1,4 +1,4 @@ -class GitHubPermission : System.IEquatable[Object] { +class GitHubPermission : System.IEquatable[Object] { # The programmatic name of the permission as returned by the GitHub API [string] $Name diff --git a/src/functions/private/Actions/Import-GitHubEventData.ps1 b/src/functions/private/Actions/Import-GitHubEventData.ps1 index 1446dd01a..bc69151a2 100644 --- a/src/functions/private/Actions/Import-GitHubEventData.ps1 +++ b/src/functions/private/Actions/Import-GitHubEventData.ps1 @@ -1,4 +1,4 @@ -#Requires -Modules @{ ModuleName = 'CasingStyle'; RequiredVersion = '1.0.2' } +#Requires -Modules @{ ModuleName = 'CasingStyle'; RequiredVersion = '1.0.2' } function Import-GitHubEventData { <# diff --git a/src/functions/private/Actions/Import-GitHubRunnerData.ps1 b/src/functions/private/Actions/Import-GitHubRunnerData.ps1 index 527860aad..cdef313cd 100644 --- a/src/functions/private/Actions/Import-GitHubRunnerData.ps1 +++ b/src/functions/private/Actions/Import-GitHubRunnerData.ps1 @@ -1,4 +1,4 @@ -function Import-GitHubRunnerData { +function Import-GitHubRunnerData { <# .SYNOPSIS Import data about the runner that is running the workflow. diff --git a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 index 0d7b4e347..c381f7d03 100644 --- a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 +++ b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflowRunByRepo { +filter Get-GitHubWorkflowRunByRepo { <# .SYNOPSIS List workflow runs for a repository. diff --git a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 index 6199f1a1b..695b84037 100644 --- a/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 +++ b/src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflowRunByWorkflow { +filter Get-GitHubWorkflowRunByWorkflow { <# .SYNOPSIS List workflow runs for a workflow diff --git a/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 b/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 index 8fbabf597..f64da3c11 100644 --- a/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubKeyVaultJWTSignature { +function Add-GitHubKeyVaultJWTSignature { <# .SYNOPSIS Adds a JWT signature using Azure Key Vault. diff --git a/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 b/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 index 0d7d7606e..9c35e3940 100644 --- a/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubLocalJWTSignature { +function Add-GitHubLocalJWTSignature { <# .SYNOPSIS Signs a JSON Web Token (JWT) using a local RSA private key. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 index 0ef0a5335..fe324e64a 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAppAsAuthenticatedApp { +filter Get-GitHubAppAsAuthenticatedApp { <# .SYNOPSIS Get the authenticated app diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 index dc3d4ff8a..b226065e1 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppBySlug { +function Get-GitHubAppBySlug { <# .SYNOPSIS Get an app diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 index 37961094f..6c99184e6 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallableOrganization { +function Get-GitHubAppInstallableOrganization { <# .SYNOPSIS Get enterprise-owned organizations that can have GitHub Apps installed diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 index 12da2d951..b7e0b10a8 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForAuthenticatedAppAsList { +function Get-GitHubAppInstallationForAuthenticatedAppAsList { <# .SYNOPSIS List installations for the authenticated app. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 index f515baf8c..e114658d2 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForAuthenticatedAppByID { +function Get-GitHubAppInstallationForAuthenticatedAppByID { <# .SYNOPSIS Get an installation for the authenticated app. diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 index 82d30e239..885a351ac 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForEnterpriseOrganization { +function Get-GitHubAppInstallationForEnterpriseOrganization { <# .SYNOPSIS List GitHub Apps installed on an enterprise-owned organization diff --git a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 index 547195200..f3ae0e5d3 100644 --- a/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationForOrganization { +function Get-GitHubAppInstallationForOrganization { <# .SYNOPSIS List app installations for an organization diff --git a/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 index a500a9697..3186ecdde 100644 --- a/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Install-GitHubAppOnEnterpriseOrganization { +function Install-GitHubAppOnEnterpriseOrganization { <# .SYNOPSIS Install an app on an Enterprise-owned organization diff --git a/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 b/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 index 50189f1f2..c61f6b6bf 100644 --- a/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 +++ b/src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1 @@ -1,4 +1,4 @@ -function New-GitHubUnsignedJWT { +function New-GitHubUnsignedJWT { <# .SYNOPSIS Creates an unsigned JSON Web Token (JWT) for a GitHub App. diff --git a/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 b/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 index 31d1ecf98..72356fc0c 100644 --- a/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubJWTRefreshRequired { +function Test-GitHubJWTRefreshRequired { <# .SYNOPSIS Test if the GitHub JWT should be refreshed. diff --git a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 index fb58c7bba..a71ac7569 100644 --- a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1 @@ -1,4 +1,4 @@ -function Uninstall-GitHubAppAsApp { +function Uninstall-GitHubAppAsApp { <# .SYNOPSIS Delete an installation for the authenticated app. diff --git a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 index be4def9bf..19e50b795 100644 --- a/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Uninstall-GitHubAppOnEnterpriseOrganization { +function Uninstall-GitHubAppOnEnterpriseOrganization { <# .SYNOPSIS Uninstall a GitHub App from an enterprise-owned organization. diff --git a/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 b/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 index bb4f6a217..7fff17ed9 100644 --- a/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 +++ b/src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubAppJWT { +function Update-GitHubAppJWT { <# .SYNOPSIS Updates a JSON Web Token (JWT) for a GitHub App context. diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 index ad215d786..5dff1e189 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactById.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifactById { +function Get-GitHubArtifactById { <# .SYNOPSIS Retrieves a specific artifact from a GitHub Actions workflow run. diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 index 7880838a7..a74e04802 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifactFromRepository { +function Get-GitHubArtifactFromRepository { <# .SYNOPSIS Lists artifacts for a GitHub repository. diff --git a/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 b/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 index 4120b0940..4d9526ca8 100644 --- a/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 +++ b/src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifactFromWorkflowRun { +function Get-GitHubArtifactFromWorkflowRun { <# .SYNOPSIS Retrieves artifacts from a specific GitHub Actions workflow run. diff --git a/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 b/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 index 61b2d7b7a..c8fd25a2b 100644 --- a/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 +++ b/src/functions/private/Auth/Cli/Connect-GithubCli.ps1 @@ -1,4 +1,4 @@ -filter Connect-GitHubCli { +filter Connect-GitHubCli { <# .SYNOPSIS Authenticates to GitHub CLI using a secure token from the provided context. diff --git a/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 b/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 index 4d1b03bce..f0936fa4a 100644 --- a/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Assert-GitHubContext.ps1 @@ -1,4 +1,4 @@ -filter Assert-GitHubContext { +filter Assert-GitHubContext { <# .SYNOPSIS Check if the context meets the requirements for the command. diff --git a/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 b/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 index d8461ccc9..987696931 100644 --- a/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Remove-GitHubContext.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubContext { +filter Remove-GitHubContext { <# .SYNOPSIS Removes a context from the context vault. diff --git a/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 b/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 index 93450a4c3..c1a942f6f 100644 --- a/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Resolve-GitHubContext.ps1 @@ -1,4 +1,4 @@ -filter Resolve-GitHubContext { +filter Resolve-GitHubContext { <# .SYNOPSIS Resolves the context into a GitHubContext object. diff --git a/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 b/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 index 4cdbcd3dc..43380607a 100644 --- a/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 +++ b/src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1 @@ -1,4 +1,4 @@ -function Resolve-GitHubContextSetting { +function Resolve-GitHubContextSetting { <# .SYNOPSIS Resolves a GitHub context setting based on a provided name. diff --git a/src/functions/private/Auth/Context/Set-GitHubContext.ps1 b/src/functions/private/Auth/Context/Set-GitHubContext.ps1 index c25684b2e..116d27fd2 100644 --- a/src/functions/private/Auth/Context/Set-GitHubContext.ps1 +++ b/src/functions/private/Auth/Context/Set-GitHubContext.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubContext { +function Set-GitHubContext { <# .SYNOPSIS Sets the GitHub context and stores it in the context vault. diff --git a/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 b/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 index 71f3565a6..3afa9fcda 100644 --- a/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Invoke-GitHubDeviceFlowLogin.ps1 @@ -1,4 +1,4 @@ -function Invoke-GitHubDeviceFlowLogin { +function Invoke-GitHubDeviceFlowLogin { <# .SYNOPSIS Starts the GitHub Device Flow login process. diff --git a/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 index eed8e60b7..5d7667e12 100644 --- a/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Request-GitHubAccessToken.ps1 @@ -1,4 +1,4 @@ -function Request-GitHubAccessToken { +function Request-GitHubAccessToken { <# .SYNOPSIS Request a GitHub token using the Device Flow. diff --git a/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 b/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 index 79c9481a6..44ce973b5 100644 --- a/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Request-GitHubDeviceCode.ps1 @@ -1,4 +1,4 @@ -function Request-GitHubDeviceCode { +function Request-GitHubDeviceCode { <# .SYNOPSIS Request a GitHub Device Code. diff --git a/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 b/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 index 423b1b2cd..ab0706847 100644 --- a/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Test-GitHubAccessTokenRefreshRequired.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubAccessTokenRefreshRequired { +function Test-GitHubAccessTokenRefreshRequired { <# .SYNOPSIS Test if the GitHub access token should be refreshed. diff --git a/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 index c20fa4635..d3760379f 100644 --- a/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Update-GitHubUserAccessToken.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubUserAccessToken { +function Update-GitHubUserAccessToken { <# .SYNOPSIS Updates the GitHub access token. diff --git a/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 b/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 index a9c3794d4..9896f4976 100644 --- a/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 +++ b/src/functions/private/Auth/DeviceFlow/Wait-GitHubAccessToken.ps1 @@ -1,4 +1,4 @@ -function Wait-GitHubAccessToken { +function Wait-GitHubAccessToken { <# .SYNOPSIS Waits for the GitHub Device Flow to complete. diff --git a/src/functions/private/Auth/Get-GitHubToken.ps1 b/src/functions/private/Auth/Get-GitHubToken.ps1 index d472bff8c..a33037d46 100644 --- a/src/functions/private/Auth/Get-GitHubToken.ps1 +++ b/src/functions/private/Auth/Get-GitHubToken.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubToken { +function Get-GitHubToken { <# .SYNOPSIS Retrieves a GitHub token from environment variables as plaintext or a secure string. diff --git a/src/functions/private/Auth/Test-GitHubToken.ps1 b/src/functions/private/Auth/Test-GitHubToken.ps1 index 75cabe3c5..633338e1e 100644 --- a/src/functions/private/Auth/Test-GitHubToken.ps1 +++ b/src/functions/private/Auth/Test-GitHubToken.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubToken { +function Test-GitHubToken { <# .SYNOPSIS Tests if the GitHub token is set in the environment variables. diff --git a/src/functions/private/Branches/Get-GitHubBranchList.ps1 b/src/functions/private/Branches/Get-GitHubBranchList.ps1 index 048225ce1..e2fd4016e 100644 --- a/src/functions/private/Branches/Get-GitHubBranchList.ps1 +++ b/src/functions/private/Branches/Get-GitHubBranchList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBranchList { +filter Get-GitHubBranchList { <# .SYNOPSIS List branches diff --git a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 index 9792c3ae0..8fc2eae86 100644 --- a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 +++ b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -filter ConvertFrom-GitHubOutput { +filter ConvertFrom-GitHubOutput { <# .SYNOPSIS Gets the GitHub output. diff --git a/src/functions/private/Config/Initialize-GitHubConfig.ps1 b/src/functions/private/Config/Initialize-GitHubConfig.ps1 index b51d3da52..bbd55338b 100644 --- a/src/functions/private/Config/Initialize-GitHubConfig.ps1 +++ b/src/functions/private/Config/Initialize-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Initialize-GitHubConfig { +function Initialize-GitHubConfig { <# .SYNOPSIS Initialize the GitHub module configuration. diff --git a/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 b/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 index 7c1b52749..035e0d37f 100644 --- a/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 +++ b/src/functions/private/Core/ConvertTo-GitHubGraphQLField.ps1 @@ -1,4 +1,4 @@ -function ConvertTo-GitHubGraphQLField { +function ConvertTo-GitHubGraphQLField { <# .SYNOPSIS Converts property names to their corresponding GitHub GraphQL field syntax. diff --git a/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 b/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 index b1e75b910..a26ff00b8 100644 --- a/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 +++ b/src/functions/private/Enterprise/Get-GitHubEnterpriseByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterpriseByName { +function Get-GitHubEnterpriseByName { <# .SYNOPSIS Retrieves details about a GitHub Enterprise instance by name (slug). diff --git a/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 b/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 index 73840555b..b30d4fbb4 100644 --- a/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 +++ b/src/functions/private/Enterprise/Get-GitHubEnterpriseList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterpriseList { +function Get-GitHubEnterpriseList { <# .SYNOPSIS Retrieves a list of all GitHub Enterprise instances. diff --git a/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 b/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 index 8be956e67..dfd79e826 100644 --- a/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 +++ b/src/functions/private/Environments/Get-GitHubEnvironmentByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEnvironmentByName { +filter Get-GitHubEnvironmentByName { <# .SYNOPSIS Retrieves details of a specified GitHub environment. diff --git a/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 b/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 index 7d9dce21f..b86799850 100644 --- a/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 +++ b/src/functions/private/Environments/Get-GitHubEnvironmentList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEnvironmentList { +filter Get-GitHubEnvironmentList { <# .SYNOPSIS Lists the environments for a repository. diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 index 23a339c41..51e8d35ce 100644 --- a/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 +++ b/src/functions/private/Gitignore/Get-GitHubGitignoreByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubGitignoreByName { +filter Get-GitHubGitignoreByName { <# .SYNOPSIS Get a gitignore template diff --git a/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 b/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 index 596181d97..ee649b12c 100644 --- a/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 +++ b/src/functions/private/Gitignore/Get-GitHubGitignoreList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubGitignoreList { +filter Get-GitHubGitignoreList { <# .SYNOPSIS Get all gitignore templates diff --git a/src/functions/private/License/Get-GitHubLicenseByName.ps1 b/src/functions/private/License/Get-GitHubLicenseByName.ps1 index e60977b70..00ddf1bee 100644 --- a/src/functions/private/License/Get-GitHubLicenseByName.ps1 +++ b/src/functions/private/License/Get-GitHubLicenseByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubLicenseByName { +filter Get-GitHubLicenseByName { <# .SYNOPSIS Get a license diff --git a/src/functions/private/License/Get-GitHubLicenseList.ps1 b/src/functions/private/License/Get-GitHubLicenseList.ps1 index af8b3429e..3d99c2cb8 100644 --- a/src/functions/private/License/Get-GitHubLicenseList.ps1 +++ b/src/functions/private/License/Get-GitHubLicenseList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubLicenseList { +filter Get-GitHubLicenseList { <# .SYNOPSIS Get all commonly used licenses diff --git a/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 b/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 index f641d91ce..94fcad8f4 100644 --- a/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 +++ b/src/functions/private/License/Get-GitHubRepositoryLicense.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryLicense { +filter Get-GitHubRepositoryLicense { <# .SYNOPSIS Get the license for a repository diff --git a/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 index 90d690f06..c89ab39f8 100644 --- a/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Block-GitHubUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Block-GitHubUserByOrganization { +filter Block-GitHubUserByOrganization { <# .SYNOPSIS Block a user from an organization diff --git a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 index 0eb5d211a..096eff942 100644 --- a/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Get-GitHubBlockedUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBlockedUserByOrganization { +filter Get-GitHubBlockedUserByOrganization { <# .SYNOPSIS List users blocked by an organization diff --git a/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 index 9eebeafd0..344101cef 100644 --- a/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Test-GitHubBlockedUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubBlockedUserByOrganization { +filter Test-GitHubBlockedUserByOrganization { <# .SYNOPSIS Check if a user is blocked by an organization diff --git a/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 b/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 index 2af822011..ba1fbb1fc 100644 --- a/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 +++ b/src/functions/private/Organization/Blocking/Unblock-GitHubUserByOrganization.ps1 @@ -1,4 +1,4 @@ -filter Unblock-GitHubUserByOrganization { +filter Unblock-GitHubUserByOrganization { <# .SYNOPSIS Unblock a user from an organization diff --git a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 index 2d871fc07..6c00b0eac 100644 --- a/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 +++ b/src/functions/private/Organization/Get-GitHubAllOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAllOrganization { +filter Get-GitHubAllOrganization { <# .SYNOPSIS List organizations diff --git a/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 b/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 index f06ac7002..5ef0899ee 100644 --- a/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 +++ b/src/functions/private/Organization/Get-GitHubOrganizationByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubOrganizationByName { +filter Get-GitHubOrganizationByName { <# .SYNOPSIS Get an organization diff --git a/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 b/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 index 577d91f49..0fad06297 100644 --- a/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 +++ b/src/functions/private/Organization/Get-GitHubOrganizationListForAuthUser.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubOrganizationListForAuthUser { +function Get-GitHubOrganizationListForAuthUser { <# .SYNOPSIS Retrieves a list of all GitHub organizations for the authenticated user. diff --git a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 index 800d45cc2..25257ecdf 100644 --- a/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 +++ b/src/functions/private/Organization/Get-GitHubUserOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserOrganization { +filter Get-GitHubUserOrganization { <# .SYNOPSIS List organizations for a user diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 index 81c1abc12..7d9e8cc27 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByID.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetByID { +filter Get-GitHubReleaseAssetByID { <# .SYNOPSIS Get a release asset by ID diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 index 37ecb294b..3463a487d 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByReleaseID.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetByReleaseID { +filter Get-GitHubReleaseAssetByReleaseID { <# .SYNOPSIS List release assets diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 index 9724a7a65..b51471287 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetByTag.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetByTag { +filter Get-GitHubReleaseAssetByTag { <# .SYNOPSIS Get release assets by tag name diff --git a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 index 0d4ffc548..26628315f 100644 --- a/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 +++ b/src/functions/private/Releases/Assets/Get-GitHubReleaseAssetFromLatest.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAssetFromLatest { +filter Get-GitHubReleaseAssetFromLatest { <# .SYNOPSIS Get the assets of the latest release diff --git a/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 b/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 index 7782b1d3d..f3e499ed4 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseAll.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAll { +filter Get-GitHubReleaseAll { <# .SYNOPSIS List releases diff --git a/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 b/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 index 803e793c2..a7564d770 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseByID.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseByID { +filter Get-GitHubReleaseByID { <# .SYNOPSIS Get a release diff --git a/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 b/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 index bcf521e7d..dea520db9 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseByTagName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseByTagName { +filter Get-GitHubReleaseByTagName { <# .SYNOPSIS Get a release by tag name diff --git a/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 b/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 index b682b45bd..6573b0908 100644 --- a/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 +++ b/src/functions/private/Releases/Get-GitHubReleaseLatest.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseLatest { +filter Get-GitHubReleaseLatest { <# .SYNOPSIS Get the latest release diff --git a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 index 8244f780f..7e7aa0460 100644 --- a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 +++ b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryAutolinkById { +filter Get-GitHubRepositoryAutolinkById { <# .SYNOPSIS Get an autolink reference of a repository diff --git a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 index f54c23850..485ab8119 100644 --- a/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 +++ b/src/functions/private/Repositories/Autolinks/Get-GitHubRepositoryAutolinkList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryAutolinkList { +filter Get-GitHubRepositoryAutolinkList { <# .SYNOPSIS List all autolinks of a repository diff --git a/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 b/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 index 49235678d..b2a446f88 100644 --- a/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 +++ b/src/functions/private/Repositories/Get-GitHubMyRepositories.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyRepositories { +filter Get-GitHubMyRepositories { <# .SYNOPSIS List repositories for the authenticated user. diff --git a/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 b/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 index 4cf580d02..ff9d01bf8 100644 --- a/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 +++ b/src/functions/private/Repositories/Get-GitHubMyRepositoryByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyRepositoryByName { +filter Get-GitHubMyRepositoryByName { <# .SYNOPSIS List repositories for the authenticated user. diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 index 006c74328..d3788be41 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryByName { +filter Get-GitHubRepositoryByName { <# .SYNOPSIS Get a repository diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 index c957fc458..823ff64d3 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryByNameAndTeam.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryByNameAndTeam { +filter Get-GitHubRepositoryByNameAndTeam { <# .SYNOPSIS Get the permission level for a team on a repository. diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 index 007e3600d..92cfe5b54 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryListByOwner.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryListByOwner { +filter Get-GitHubRepositoryListByOwner { <# .SYNOPSIS List repositories for a user diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 index 430c732e4..f722df323 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryListByTeam { +filter Get-GitHubRepositoryListByTeam { <# .SYNOPSIS List team repositories. diff --git a/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 index 56d0fe43e..8202415f8 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryAsFork.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryAsFork { +filter New-GitHubRepositoryAsFork { <# .SYNOPSIS Create a fork diff --git a/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 index 6b6adc416..3e18af4cb 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryFromTemplate.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryFromTemplate { +filter New-GitHubRepositoryFromTemplate { <# .SYNOPSIS Create a repository using a template diff --git a/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 index a1981d72e..7007658ca 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryOrg.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryOrg { +filter New-GitHubRepositoryOrg { <# .SYNOPSIS Create an organization repository diff --git a/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 b/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 index cfb86eb3e..26a7e1076 100644 --- a/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 +++ b/src/functions/private/Repositories/New-GitHubRepositoryUser.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryUser { +filter New-GitHubRepositoryUser { <# .SYNOPSIS Create a repository for the authenticated user diff --git a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 index 3a9a1f8c6..f9bdd562d 100644 --- a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 +++ b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryRuleSuiteById { +filter Get-GitHubRepositoryRuleSuiteById { <# .SYNOPSIS Get a repository rule suite diff --git a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 index 7d1311f3d..dcb029a13 100644 --- a/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 +++ b/src/functions/private/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuiteList.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryRuleSuiteList { +filter Get-GitHubRepositoryRuleSuiteList { <# .SYNOPSIS List repository rule suites diff --git a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 index cdc2f9e7f..7493b3b66 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretEnvironmentByName { +function Get-GitHubSecretEnvironmentByName { <# .SYNOPSIS Get an environment secret. diff --git a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 index af2c588a1..91198f552 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretEnvironmentList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretEnvironmentList { +function Get-GitHubSecretEnvironmentList { <# .SYNOPSIS List environment secrets. diff --git a/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 b/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 index 34bc739df..d33a68b10 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretFromOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretFromOrganization { +function Get-GitHubSecretFromOrganization { <# .SYNOPSIS List repository organization secrets. diff --git a/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 index c1bb7ae08..48ff3e591 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretOwnerByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretOwnerByName { +function Get-GitHubSecretOwnerByName { <# .SYNOPSIS Create or update an organization secret. diff --git a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 index e8d6928b6..876c5a06e 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretOwnerList { +function Get-GitHubSecretOwnerList { <# .SYNOPSIS List organization secrets. diff --git a/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 b/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 index 1d20738c9..c9284f628 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretRepositoryByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretRepositoryByName { +function Get-GitHubSecretRepositoryByName { <# .SYNOPSIS Get a repository secret. diff --git a/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 index 49a40c2d8..8b7a04fa7 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretRepositoryList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretRepositoryList { +function Get-GitHubSecretRepositoryList { <# .SYNOPSIS List repository secrets. diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 index 318088cd8..2d33f62fb 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForActionOnEnvironment { +function Get-GitHubPublicKeyForActionOnEnvironment { <# .SYNOPSIS Get an environment public key. diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 index 7b008a5b2..2232fe74a 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForActionOnOrganization { +function Get-GitHubPublicKeyForActionOnOrganization { <# .SYNOPSIS Get an organization public key. diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 index e29aeed80..174566349 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForActionOnRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForActionOnRepository { +function Get-GitHubPublicKeyForActionOnRepository { <# .SYNOPSIS Get a repository public key. diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 index cae97852f..4e6ad64ea 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForCodespacesOnOrganization { +function Get-GitHubPublicKeyForCodespacesOnOrganization { <# .SYNOPSIS Get an organization public key. diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 index 9cfa87f39..c67cb597a 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForCodespacesOnRepository { +function Get-GitHubPublicKeyForCodespacesOnRepository { <# .SYNOPSIS Get a repository public key. diff --git a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 index 95b8595ff..c31f13c7b 100644 --- a/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 +++ b/src/functions/private/Secrets/PublicKey/Get-GitHubPublicKeyForCodespacesOnUser.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKeyForCodespacesOnUser { +function Get-GitHubPublicKeyForCodespacesOnUser { <# .SYNOPSIS Get public key for the authenticated user. diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 index 1f646e608..b25d32db6 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromEnvironment.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretFromEnvironment { +function Remove-GitHubSecretFromEnvironment { <# .SYNOPSIS Delete an environment secret. diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 index 6dbf4d7f1..2841d95fa 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromOwner.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretFromOwner { +function Remove-GitHubSecretFromOwner { <# .SYNOPSIS Delete an organization secret. diff --git a/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 b/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 index c19b49a1f..400739b82 100644 --- a/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 +++ b/src/functions/private/Secrets/Remove-GitHubSecretFromRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretFromRepository { +function Remove-GitHubSecretFromRepository { <# .SYNOPSIS Delete a repository secret. diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 index 8c25cfcc2..927f55681 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretOnEnvironment { +function Set-GitHubSecretOnEnvironment { <# .SYNOPSIS Create or update an environment secret. diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 index a1d17bf9c..abbda4608 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnOwner.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretOnOwner { +function Set-GitHubSecretOnOwner { <# .SYNOPSIS Create or update an organization secret. diff --git a/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 b/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 index 4a7212926..9c1091bb4 100644 --- a/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 +++ b/src/functions/private/Secrets/Set-GitHubSecretOnRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretOnRepository { +function Set-GitHubSecretOnRepository { <# .SYNOPSIS Create or update a repository secret. diff --git a/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 b/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 index a9d65c6ad..918eec535 100644 --- a/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamBySlug.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubTeamBySlug { +function Get-GitHubTeamBySlug { <# .SYNOPSIS Get a team by name diff --git a/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 b/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 index af1473d3f..4ebb42862 100644 --- a/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamListByOrg.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubTeamListByOrg { +function Get-GitHubTeamListByOrg { <# .SYNOPSIS List teams diff --git a/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 b/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 index c24f3d32c..89ff9bd47 100644 --- a/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 +++ b/src/functions/private/Teams/Get-GitHubTeamListByRepo.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubTeamListByRepo { +filter Get-GitHubTeamListByRepo { <# .SYNOPSIS List repository teams. diff --git a/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 b/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 index 8be9ff3c5..cf5923b3b 100644 --- a/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Block-GitHubUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Block-GitHubUserByUser { +filter Block-GitHubUserByUser { <# .SYNOPSIS Block a user diff --git a/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 index 17220ec67..24e84c0c4 100644 --- a/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Get-GitHubBlockedUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBlockedUserByUser { +filter Get-GitHubBlockedUserByUser { <# .SYNOPSIS List users blocked by the authenticated user diff --git a/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 b/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 index 095d3e64a..1e9c46330 100644 --- a/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Test-GitHubBlockedUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubBlockedUserByUser { +filter Test-GitHubBlockedUserByUser { <# .SYNOPSIS Check if a user is blocked by the authenticated user diff --git a/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 b/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 index 5cbf1ceed..7b3277cb0 100644 --- a/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 +++ b/src/functions/private/Users/Blocking/Unblock-GitHubUserByUser.ps1 @@ -1,4 +1,4 @@ -filter Unblock-GitHubUserByUser { +filter Unblock-GitHubUserByUser { <# .SYNOPSIS Unblock a user diff --git a/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 index d943ae302..8a4e9a58e 100644 --- a/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 +++ b/src/functions/private/Users/Emails/Get-GitHubUserAllEmail.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserAllEmail { +filter Get-GitHubUserAllEmail { <# .SYNOPSIS List email addresses for the authenticated user diff --git a/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 b/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 index 5d2ae28d2..44fccd672 100644 --- a/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 +++ b/src/functions/private/Users/Emails/Get-GitHubUserPublicEmail.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserPublicEmail { +filter Get-GitHubUserPublicEmail { <# .SYNOPSIS List public email addresses for the authenticated user diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 index b26cabf04..198bcd3f8 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowersOfUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowersOfUser { +filter Get-GitHubUserFollowersOfUser { <# .SYNOPSIS List followers of a user diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 index 8ed61efab..59ff6fc54 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowingMe.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowingMe { +filter Get-GitHubUserFollowingMe { <# .SYNOPSIS List the people the authenticated user follows diff --git a/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 index c87264270..c67816599 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserFollowingUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowingUser { +filter Get-GitHubUserFollowingUser { <# .SYNOPSIS List the people a user follows diff --git a/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 b/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 index 97b82b16c..05abfa288 100644 --- a/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 +++ b/src/functions/private/Users/Followers/Get-GitHubUserMyFollower.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyFollower { +filter Get-GitHubUserMyFollower { <# .SYNOPSIS List followers of the authenticated user diff --git a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 index 3a1a82efe..dd92bf3a1 100644 --- a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 +++ b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByMe.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubUserFollowedByMe { +filter Test-GitHubUserFollowedByMe { <# .SYNOPSIS Check if a person is followed by the authenticated user diff --git a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 index ffd3ad967..8b5681127 100644 --- a/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 +++ b/src/functions/private/Users/Followers/Test-GitHubUserFollowedByUser.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubUserFollowedByUser { +filter Test-GitHubUserFollowedByUser { <# .SYNOPSIS Check if a user follows another user diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 index 020099515..25919a237 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserGpgKeyForUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserGpgKeyForUser { +filter Get-GitHubUserGpgKeyForUser { <# .SYNOPSIS List GPG keys for a user diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 index 87eaa5cf5..d1e80d418 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyGpgKey { +filter Get-GitHubUserMyGpgKey { <# .SYNOPSIS List GPG keys for the authenticated user diff --git a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 index 90b7efaee..d2cd359b5 100644 --- a/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 +++ b/src/functions/private/Users/GPG-Keys/Get-GitHubUserMyGpgKeyById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyGpgKeyById { +filter Get-GitHubUserMyGpgKeyById { <# .SYNOPSIS Get a GPG key for the authenticated user diff --git a/src/functions/private/Users/Get-GitHubAllUser.ps1 b/src/functions/private/Users/Get-GitHubAllUser.ps1 index 3e1fc9f34..382babfbf 100644 --- a/src/functions/private/Users/Get-GitHubAllUser.ps1 +++ b/src/functions/private/Users/Get-GitHubAllUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAllUser { +filter Get-GitHubAllUser { <# .SYNOPSIS List users diff --git a/src/functions/private/Users/Get-GitHubMyUser.ps1 b/src/functions/private/Users/Get-GitHubMyUser.ps1 index e9fcb2e57..457231cb4 100644 --- a/src/functions/private/Users/Get-GitHubMyUser.ps1 +++ b/src/functions/private/Users/Get-GitHubMyUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyUser { +filter Get-GitHubMyUser { <# .SYNOPSIS Get the authenticated user diff --git a/src/functions/private/Users/Get-GitHubUserByName.ps1 b/src/functions/private/Users/Get-GitHubUserByName.ps1 index 61a63ec83..67a3757dc 100644 --- a/src/functions/private/Users/Get-GitHubUserByName.ps1 +++ b/src/functions/private/Users/Get-GitHubUserByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserByName { +filter Get-GitHubUserByName { <# .SYNOPSIS Get a user diff --git a/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 index 04164fb3d..fd4fa4e4e 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserKeyForUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserKeyForUser { +filter Get-GitHubUserKeyForUser { <# .SYNOPSIS List public SSH keys for a user diff --git a/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 index ef758320f..63235c289 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserMyKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyKey { +filter Get-GitHubUserMyKey { <# .SYNOPSIS List public SSH keys for the authenticated user diff --git a/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 b/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 index 7c4edfe3f..3de9268d1 100644 --- a/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 +++ b/src/functions/private/Users/Keys/Get-GitHubUserMyKeyById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMyKeyById { +filter Get-GitHubUserMyKeyById { <# .SYNOPSIS Get a public SSH key for the authenticated user diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 index 1f388ec12..ff83153ec 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMySigningKey { +filter Get-GitHubUserMySigningKey { <# .SYNOPSIS List SSH signing keys for the authenticated user diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 index dfe095f47..6ef442b85 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserMySigningKeyById.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserMySigningKeyById { +filter Get-GitHubUserMySigningKeyById { <# .SYNOPSIS Get an SSH signing key for the authenticated user diff --git a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 index 5f7d3ec80..dba698853 100644 --- a/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 +++ b/src/functions/private/Users/SSH-Signing-Keys/Get-GitHubUserSigningKeyForUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserSigningKeyForUser { +filter Get-GitHubUserSigningKeyForUser { <# .SYNOPSIS List SSH signing keys for a user diff --git a/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 b/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 index 052ab74a5..663097177 100644 --- a/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 +++ b/src/functions/private/Users/Social-Accounts/Get-GitHubMyUserSocials.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMyUserSocials { +filter Get-GitHubMyUserSocials { <# .SYNOPSIS List social accounts for the authenticated user diff --git a/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 b/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 index 9283b15db..4f678b85e 100644 --- a/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 +++ b/src/functions/private/Users/Social-Accounts/Get-GitHubUserSocialsByName.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserSocialsByName { +filter Get-GitHubUserSocialsByName { <# .SYNOPSIS List social accounts for a user diff --git a/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 b/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 index c663e9980..8318afa66 100644 --- a/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 +++ b/src/functions/private/Utilities/PowerShell/Get-FunctionParameter.ps1 @@ -1,4 +1,4 @@ -function Get-FunctionParameter { +function Get-FunctionParameter { <# .SYNOPSIS Get the parameters and their final value in a function. diff --git a/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 b/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 index 17dd9bf81..bb1b52c59 100644 --- a/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 +++ b/src/functions/private/Utilities/PowerShell/Get-PSCallStackPath.ps1 @@ -1,4 +1,4 @@ -function Get-PSCallStackPath { +function Get-PSCallStackPath { <# .SYNOPSIS Create a string representation of the current call stack. diff --git a/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 b/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 index dd36d321d..e091b892a 100644 --- a/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 +++ b/src/functions/private/Utilities/PowerShell/Test-GitHubAzPowerShell.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubAzPowerShell { +function Test-GitHubAzPowerShell { <# .SYNOPSIS Tests if Azure PowerShell module is installed and authenticated. diff --git a/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 b/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 index 52acc9af8..571c05219 100644 --- a/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 +++ b/src/functions/private/Utilities/PowerShell/Test-GitHubAzureCLI.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubAzureCLI { +function Test-GitHubAzureCLI { <# .SYNOPSIS Tests if Azure CLI is installed and authenticated. diff --git a/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 index 7064f0e15..6de91d93e 100644 --- a/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableEnvironmentByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableEnvironmentByName { +function Get-GitHubVariableEnvironmentByName { <# .SYNOPSIS Retrieves a specific variable from a GitHub repository. diff --git a/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 b/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 index f0429711e..df283e97b 100644 --- a/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableEnvironmentList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableEnvironmentList { +function Get-GitHubVariableEnvironmentList { <# .SYNOPSIS Retrieves all variables for a specified environment in a GitHub repository. diff --git a/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 b/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 index 50c5ba66d..26691f1dc 100644 --- a/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableFromOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableFromOrganization { +function Get-GitHubVariableFromOrganization { <# .SYNOPSIS List repository organization variables. diff --git a/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 index 5bc13f35b..7cbd2204d 100644 --- a/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableOwnerByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableOwnerByName { +function Get-GitHubVariableOwnerByName { <# .SYNOPSIS Get an organization variable. diff --git a/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 b/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 index c097eebbd..8adff07d0 100644 --- a/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableOwnerList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableOwnerList { +function Get-GitHubVariableOwnerList { <# .SYNOPSIS List organization variables diff --git a/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 b/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 index 00081bc94..ce85ead3d 100644 --- a/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableRepositoryByName.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableRepositoryByName { +function Get-GitHubVariableRepositoryByName { <# .SYNOPSIS Get a repository variable diff --git a/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 b/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 index d405a89be..c566ba02c 100644 --- a/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 +++ b/src/functions/private/Variables/Get-GitHubVariableRepositoryList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableRepositoryList { +function Get-GitHubVariableRepositoryList { <# .SYNOPSIS List repository variables. diff --git a/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 b/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 index ca086f8e7..9e9134db8 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariableOnEnvironment { +function New-GitHubVariableOnEnvironment { <# .SYNOPSIS Create an environment variable. diff --git a/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 b/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 index 7f3f719ed..ca6f09b79 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnOwner.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariableOnOwner { +function New-GitHubVariableOnOwner { <# .SYNOPSIS Create an organization variable. diff --git a/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 b/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 index 77e378d71..32ce97d1f 100644 --- a/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 +++ b/src/functions/private/Variables/New-GitHubVariableOnRepository.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariableOnRepository { +function New-GitHubVariableOnRepository { <# .SYNOPSIS Create a repository variable. diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 index d940f45ba..db27494ba 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromEnvironment.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableFromEnvironment { +function Remove-GitHubVariableFromEnvironment { <# .SYNOPSIS Delete an environment variable. diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 index a1bb55e07..6b866e21c 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromOwner.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableFromOwner { +function Remove-GitHubVariableFromOwner { <# .SYNOPSIS Delete an organization variable. diff --git a/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 b/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 index b4148ed0b..b40835171 100644 --- a/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 +++ b/src/functions/private/Variables/Remove-GitHubVariableFromRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableFromRepository { +function Remove-GitHubVariableFromRepository { <# .SYNOPSIS Delete a repository variable. diff --git a/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 index 55fbf9868..3125992b0 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnEnvironment.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariableOnEnvironment { +function Update-GitHubVariableOnEnvironment { <# .SYNOPSIS Update an environment variable. diff --git a/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 index a3b2b32fe..c39389d5d 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnOwner.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariableOnOwner { +function Update-GitHubVariableOnOwner { <# .SYNOPSIS Update an organization variable. diff --git a/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 b/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 index 8591c5182..a737ccded 100644 --- a/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 +++ b/src/functions/private/Variables/Update-GitHubVariableOnRepository.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariableOnRepository { +function Update-GitHubVariableOnRepository { <# .SYNOPSIS Update a repository variable. diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 index cb4813128..2694e3361 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByID.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDeliveryByID { +function Get-GitHubAppWebhookDeliveryByID { <# .SYNOPSIS Get a delivery for an app webhook diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 index 2ced60df7..64c9b68c4 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryByList.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDeliveryByList { +function Get-GitHubAppWebhookDeliveryByList { <# .SYNOPSIS List deliveries for an app webhook diff --git a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 index 5a645d0d9..8d85ae38f 100644 --- a/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 +++ b/src/functions/private/Webhooks/Get-GitHubAppWebhookDeliveryToRedeliver.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDeliveryToRedeliver { +function Get-GitHubAppWebhookDeliveryToRedeliver { <# .SYNOPSIS Short description diff --git a/src/functions/public/API/Invoke-GitHubAPI.ps1 b/src/functions/public/API/Invoke-GitHubAPI.ps1 index 48e65d150..8bae373aa 100644 --- a/src/functions/public/API/Invoke-GitHubAPI.ps1 +++ b/src/functions/public/API/Invoke-GitHubAPI.ps1 @@ -1,4 +1,4 @@ -#Requires -Modules @{ ModuleName = 'Uri'; RequiredVersion = '1.1.2' } +#Requires -Modules @{ ModuleName = 'Uri'; RequiredVersion = '1.1.2' } #Requires -Modules @{ ModuleName = 'Hashtable'; RequiredVersion = '1.1.6' } function Invoke-GitHubAPI { diff --git a/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 b/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 index bf24b44d7..23f181675 100644 --- a/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 +++ b/src/functions/public/API/Invoke-GitHubGraphQLQuery.ps1 @@ -1,4 +1,4 @@ -function Invoke-GitHubGraphQLQuery { +function Invoke-GitHubGraphQLQuery { <# .SYNOPSIS Invoke a GraphQL requests against the GitHub GraphQL API diff --git a/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 b/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 index 25913a1b5..be4e689cc 100644 --- a/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 +++ b/src/functions/public/Actions/Data/Get-GitHubEventData.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEventData { +function Get-GitHubEventData { <# .SYNOPSIS Gets data about the event that triggered the workflow. diff --git a/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 b/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 index 3e365ec64..9f83de10a 100644 --- a/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 +++ b/src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubRunnerData { +function Get-GitHubRunnerData { <# .SYNOPSIS Gets data about the runner thats running the workflow. diff --git a/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 index 5ba0ae9c8..9fd392d22 100644 --- a/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubAppInstallationRepositoryAccess { +function Add-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Grant repository access to an organization installation. diff --git a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 index e5c7ce785..3af8b5b56 100644 --- a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppAccessibleRepository { +function Get-GitHubAppAccessibleRepository { <# .SYNOPSIS Get repositories belonging to an enterprise owned organization that can be made accessible to a GitHub App diff --git a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 index f9398e160..19bc79533 100644 --- a/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppInstallationRepositoryAccess { +function Get-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Get the repositories accessible to a given GitHub App installation. diff --git a/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 b/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 index e984f5092..0ffda1302 100644 --- a/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/New-GitHubAppInstallationAccessToken.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubAppInstallationAccessToken { +filter New-GitHubAppInstallationAccessToken { <# .SYNOPSIS Create an installation access token for an app diff --git a/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 index b43942120..82b76c55f 100644 --- a/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubAppInstallationRepositoryAccess { +function Remove-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Remove repository access to an organization installation. diff --git a/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 b/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 index eae64501f..0494dcdc8 100644 --- a/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 +++ b/src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubAppInstallationRepositoryAccess { +function Update-GitHubAppInstallationRepositoryAccess { <# .SYNOPSIS Update the installation repository access between all repositories and selected repositories. diff --git a/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 index 96d5499c1..f40115499 100644 --- a/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubApp { +filter Get-GitHubApp { <# .SYNOPSIS Get the authenticated app or a specific app by its slug. diff --git a/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 b/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 index c51ab2ff6..7ecbe0a42 100644 --- a/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 +++ b/src/functions/public/Apps/GitHub App/Get-GitHubAppInstallationRequest.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubAppInstallationRequest { +filter Get-GitHubAppInstallationRequest { <# .SYNOPSIS List installation requests for the authenticated app. diff --git a/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 index 1de5d2b58..9617a316f 100644 --- a/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 @@ -1,4 +1,4 @@ -function Install-GitHubApp { +function Install-GitHubApp { <# .SYNOPSIS Install an app diff --git a/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 b/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 index dc3f4258a..613d2f3cf 100644 --- a/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 +++ b/src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 @@ -1,4 +1,4 @@ -function Uninstall-GitHubApp { +function Uninstall-GitHubApp { <# .SYNOPSIS Uninstall a GitHub App. diff --git a/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 index b62246643..78c8a9dde 100644 --- a/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Get-GitHubArtifact.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubArtifact { +function Get-GitHubArtifact { <# .SYNOPSIS Retrieves GitHub Actions artifacts from a repository or workflow run. diff --git a/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 index 4ff24581f..bbb26b598 100644 --- a/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubArtifact { +function Remove-GitHubArtifact { <# .SYNOPSIS Deletes an artifact from a GitHub repository by its unique ID. diff --git a/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 b/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 index 34cc84e9b..70df4b857 100644 --- a/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 +++ b/src/functions/public/Artifacts/Save-GitHubArtifact.ps1 @@ -1,4 +1,4 @@ -function Save-GitHubArtifact { +function Save-GitHubArtifact { <# .SYNOPSIS Downloads a GitHub Actions artifact. diff --git a/src/functions/public/Auth/Connect-GitHubAccount.ps1 b/src/functions/public/Auth/Connect-GitHubAccount.ps1 index 3da72514f..03b9e7ffa 100644 --- a/src/functions/public/Auth/Connect-GitHubAccount.ps1 +++ b/src/functions/public/Auth/Connect-GitHubAccount.ps1 @@ -1,4 +1,4 @@ -function Connect-GitHubAccount { +function Connect-GitHubAccount { <# .SYNOPSIS Connects to GitHub. diff --git a/src/functions/public/Auth/Connect-GitHubApp.ps1 b/src/functions/public/Auth/Connect-GitHubApp.ps1 index 81d85e136..e6c6adda5 100644 --- a/src/functions/public/Auth/Connect-GitHubApp.ps1 +++ b/src/functions/public/Auth/Connect-GitHubApp.ps1 @@ -1,4 +1,4 @@ -function Connect-GitHubApp { +function Connect-GitHubApp { <# .SYNOPSIS Connects to GitHub as a installation using a GitHub App. diff --git a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 b/src/functions/public/Auth/Context/Get-GitHubContext.ps1 index 70193d3e2..0357b7bed 100644 --- a/src/functions/public/Auth/Context/Get-GitHubContext.ps1 +++ b/src/functions/public/Auth/Context/Get-GitHubContext.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubContext { +function Get-GitHubContext { <# .SYNOPSIS Get the current GitHub context. diff --git a/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 b/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 index 2978cfc29..f85281b1b 100644 --- a/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 +++ b/src/functions/public/Auth/Context/Switch-GitHubContext.ps1 @@ -1,4 +1,4 @@ -function Switch-GitHubContext { +function Switch-GitHubContext { <# .SYNOPSIS Set the default context. diff --git a/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 b/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 index fff722c6c..810bbc9cd 100644 --- a/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 +++ b/src/functions/public/Auth/Disconnect-GitHubAccount.ps1 @@ -1,4 +1,4 @@ -function Disconnect-GitHubAccount { +function Disconnect-GitHubAccount { <# .SYNOPSIS Disconnects from GitHub and removes the GitHub context. diff --git a/src/functions/public/Auth/Get-GitHubAccessToken.ps1 b/src/functions/public/Auth/Get-GitHubAccessToken.ps1 index b5c070071..275c28873 100644 --- a/src/functions/public/Auth/Get-GitHubAccessToken.ps1 +++ b/src/functions/public/Auth/Get-GitHubAccessToken.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAccessToken { +function Get-GitHubAccessToken { <# .SYNOPSIS Retrieves the GitHub access token from the specified context. diff --git a/src/functions/public/Auth/Get-GitHubViewer.ps1 b/src/functions/public/Auth/Get-GitHubViewer.ps1 index c7b69f9b7..02573faf6 100644 --- a/src/functions/public/Auth/Get-GitHubViewer.ps1 +++ b/src/functions/public/Auth/Get-GitHubViewer.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubViewer { +function Get-GitHubViewer { <# .SYNOPSIS Gets the currently authenticated user. diff --git a/src/functions/public/Commands/Add-GitHubMask.ps1 b/src/functions/public/Commands/Add-GitHubMask.ps1 index 5c2eba8e2..dc6ecef64 100644 --- a/src/functions/public/Commands/Add-GitHubMask.ps1 +++ b/src/functions/public/Commands/Add-GitHubMask.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubMask { +filter Add-GitHubMask { <# .SYNOPSIS Masks a value in a log diff --git a/src/functions/public/Commands/Add-GitHubSystemPath.ps1 b/src/functions/public/Commands/Add-GitHubSystemPath.ps1 index c9cffe51a..02968ff9c 100644 --- a/src/functions/public/Commands/Add-GitHubSystemPath.ps1 +++ b/src/functions/public/Commands/Add-GitHubSystemPath.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubSystemPath { +function Add-GitHubSystemPath { <# .SYNOPSIS Adds a system path to the GitHub Actions environment diff --git a/src/functions/public/Commands/Disable-GitHubCommand.ps1 b/src/functions/public/Commands/Disable-GitHubCommand.ps1 index c2e65647b..c2b22072b 100644 --- a/src/functions/public/Commands/Disable-GitHubCommand.ps1 +++ b/src/functions/public/Commands/Disable-GitHubCommand.ps1 @@ -1,4 +1,4 @@ -function Disable-GitHubCommand { +function Disable-GitHubCommand { <# .SYNOPSIS Stops workflow commands diff --git a/src/functions/public/Commands/Enable-GitHubCommand.ps1 b/src/functions/public/Commands/Enable-GitHubCommand.ps1 index bbc33575b..ecb92949c 100644 --- a/src/functions/public/Commands/Enable-GitHubCommand.ps1 +++ b/src/functions/public/Commands/Enable-GitHubCommand.ps1 @@ -1,4 +1,4 @@ -function Enable-GitHubCommand { +function Enable-GitHubCommand { <# .SYNOPSIS Resumes workflow commands diff --git a/src/functions/public/Commands/Get-GitHubOutput.ps1 b/src/functions/public/Commands/Get-GitHubOutput.ps1 index f5730f9d6..8fad3798c 100644 --- a/src/functions/public/Commands/Get-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Get-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubOutput { +function Get-GitHubOutput { <# .SYNOPSIS Gets the GitHub output. diff --git a/src/functions/public/Commands/Reset-GitHubOutput.ps1 b/src/functions/public/Commands/Reset-GitHubOutput.ps1 index e85d0c20f..dc148c397 100644 --- a/src/functions/public/Commands/Reset-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Reset-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -function Reset-GitHubOutput { +function Reset-GitHubOutput { <# .SYNOPSIS Resets the GitHub output. diff --git a/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 b/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 index 173dd2aff..88c994302 100644 --- a/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 +++ b/src/functions/public/Commands/Set-GitHubEnvironmentVariable.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubEnvironmentVariable { +function Set-GitHubEnvironmentVariable { <# .SYNOPSIS Setting an environment variable diff --git a/src/functions/public/Commands/Set-GitHubLogGroup.ps1 b/src/functions/public/Commands/Set-GitHubLogGroup.ps1 index 64bce26c9..0af48b24d 100644 --- a/src/functions/public/Commands/Set-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Set-GitHubLogGroup.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubLogGroup { +function Set-GitHubLogGroup { <# .SYNOPSIS Encapsulates commands with a log group in GitHub Actions diff --git a/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 b/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 index 367967b6c..91b32e07f 100644 --- a/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 +++ b/src/functions/public/Commands/Set-GitHubNoCommandGroup.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubNoCommandGroup { +function Set-GitHubNoCommandGroup { <# .SYNOPSIS Disables workflow commands for a block of code. diff --git a/src/functions/public/Commands/Set-GitHubOutput.ps1 b/src/functions/public/Commands/Set-GitHubOutput.ps1 index 2216a9688..42b5d2ad6 100644 --- a/src/functions/public/Commands/Set-GitHubOutput.ps1 +++ b/src/functions/public/Commands/Set-GitHubOutput.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubOutput { +function Set-GitHubOutput { <# .SYNOPSIS Sets the GitHub output for a given key and value. diff --git a/src/functions/public/Commands/Set-GitHubStepSummary.ps1 b/src/functions/public/Commands/Set-GitHubStepSummary.ps1 index 6fabeeed0..5ade7672b 100644 --- a/src/functions/public/Commands/Set-GitHubStepSummary.ps1 +++ b/src/functions/public/Commands/Set-GitHubStepSummary.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubStepSummary { +function Set-GitHubStepSummary { <# .SYNOPSIS Set a summary for the step in GitHub Actions diff --git a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 index 4cea360a6..212747d2b 100644 --- a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 @@ -1,4 +1,4 @@ -function Start-GitHubLogGroup { +function Start-GitHubLogGroup { <# .SYNOPSIS Starts a log group in GitHub Actions diff --git a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 index 933c6eff6..e9bb01d4e 100644 --- a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 @@ -1,4 +1,4 @@ -function Stop-GitHubLogGroup { +function Stop-GitHubLogGroup { <# .SYNOPSIS Stops the current log group in GitHub Actions diff --git a/src/functions/public/Commands/Write-GitHubDebug.ps1 b/src/functions/public/Commands/Write-GitHubDebug.ps1 index d3c3f01b4..3d6c14f3c 100644 --- a/src/functions/public/Commands/Write-GitHubDebug.ps1 +++ b/src/functions/public/Commands/Write-GitHubDebug.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubDebug { +function Write-GitHubDebug { <# .SYNOPSIS Write a debug message in GitHub Actions diff --git a/src/functions/public/Commands/Write-GitHubError.ps1 b/src/functions/public/Commands/Write-GitHubError.ps1 index 11acae710..3fe65ad7d 100644 --- a/src/functions/public/Commands/Write-GitHubError.ps1 +++ b/src/functions/public/Commands/Write-GitHubError.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubError { +function Write-GitHubError { <# .SYNOPSIS Write a error message in GitHub Actions diff --git a/src/functions/public/Commands/Write-GitHubLog.ps1 b/src/functions/public/Commands/Write-GitHubLog.ps1 index f09b17927..17fb025e1 100644 --- a/src/functions/public/Commands/Write-GitHubLog.ps1 +++ b/src/functions/public/Commands/Write-GitHubLog.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubLog { +function Write-GitHubLog { <# .SYNOPSIS Write a colored message in GitHub Actions or locally diff --git a/src/functions/public/Commands/Write-GitHubNotice.ps1 b/src/functions/public/Commands/Write-GitHubNotice.ps1 index 167677303..1ee8ccd80 100644 --- a/src/functions/public/Commands/Write-GitHubNotice.ps1 +++ b/src/functions/public/Commands/Write-GitHubNotice.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubNotice { +function Write-GitHubNotice { <# .SYNOPSIS Write a notice message in GitHub Actions diff --git a/src/functions/public/Commands/Write-GitHubWarning.ps1 b/src/functions/public/Commands/Write-GitHubWarning.ps1 index fcf3e7997..5439166dd 100644 --- a/src/functions/public/Commands/Write-GitHubWarning.ps1 +++ b/src/functions/public/Commands/Write-GitHubWarning.ps1 @@ -1,4 +1,4 @@ -function Write-GitHubWarning { +function Write-GitHubWarning { <# .SYNOPSIS Write a warning message in GitHub Actions diff --git a/src/functions/public/Config/Get-GitHubConfig.ps1 b/src/functions/public/Config/Get-GitHubConfig.ps1 index a671d48c0..aa7248b2e 100644 --- a/src/functions/public/Config/Get-GitHubConfig.ps1 +++ b/src/functions/public/Config/Get-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubConfig { +function Get-GitHubConfig { <# .SYNOPSIS Get a GitHub module configuration. diff --git a/src/functions/public/Config/Remove-GitHubConfig.ps1 b/src/functions/public/Config/Remove-GitHubConfig.ps1 index 60a3b0c32..9e99c7718 100644 --- a/src/functions/public/Config/Remove-GitHubConfig.ps1 +++ b/src/functions/public/Config/Remove-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubConfig { +function Remove-GitHubConfig { <# .SYNOPSIS Remove a GitHub module configuration. diff --git a/src/functions/public/Config/Reset-GitHubConfig.ps1 b/src/functions/public/Config/Reset-GitHubConfig.ps1 index 2f1589301..4df18f8c9 100644 --- a/src/functions/public/Config/Reset-GitHubConfig.ps1 +++ b/src/functions/public/Config/Reset-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Reset-GitHubConfig { +function Reset-GitHubConfig { <# .SYNOPSIS Re-initializes the GitHub module configuration. diff --git a/src/functions/public/Config/Set-GitHubConfig.ps1 b/src/functions/public/Config/Set-GitHubConfig.ps1 index 05deca625..d803f50ce 100644 --- a/src/functions/public/Config/Set-GitHubConfig.ps1 +++ b/src/functions/public/Config/Set-GitHubConfig.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubConfig { +function Set-GitHubConfig { <# .SYNOPSIS Set a GitHub module configuration. diff --git a/src/functions/public/Emojis/Get-GitHubEmoji.ps1 b/src/functions/public/Emojis/Get-GitHubEmoji.ps1 index 78e9e9ea1..58861edf2 100644 --- a/src/functions/public/Emojis/Get-GitHubEmoji.ps1 +++ b/src/functions/public/Emojis/Get-GitHubEmoji.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEmoji { +filter Get-GitHubEmoji { <# .SYNOPSIS Get emojis diff --git a/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 b/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 index ade85596d..c36c6d144 100644 --- a/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 +++ b/src/functions/public/Enterprise/Get-GitHubEnterprise.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterprise { +function Get-GitHubEnterprise { <# .SYNOPSIS Retrieves GitHub Enterprise instance details for the authenticated user. diff --git a/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 b/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 index 144c5099f..daf56baee 100644 --- a/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 +++ b/src/functions/public/Enterprise/Get-GitHubEnterpriseOrganization.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubEnterpriseOrganization { +function Get-GitHubEnterpriseOrganization { <# .SYNOPSIS Get the list of organizations in a GitHub Enterprise instance. diff --git a/src/functions/public/Environments/Get-GitHubEnvironment.ps1 b/src/functions/public/Environments/Get-GitHubEnvironment.ps1 index 0afcecfda..2e74f45e4 100644 --- a/src/functions/public/Environments/Get-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Get-GitHubEnvironment.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubEnvironment { +filter Get-GitHubEnvironment { <# .SYNOPSIS Retrieves details of a specified GitHub environment or lists all environments for a repository. diff --git a/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 b/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 index 54bddde08..36d533fcb 100644 --- a/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Remove-GitHubEnvironment.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubEnvironment { +filter Remove-GitHubEnvironment { <# .SYNOPSIS Deletes an environment from a repository. diff --git a/src/functions/public/Environments/Set-GitHubEnvironment.ps1 b/src/functions/public/Environments/Set-GitHubEnvironment.ps1 index 1efd32afb..9c4097219 100644 --- a/src/functions/public/Environments/Set-GitHubEnvironment.ps1 +++ b/src/functions/public/Environments/Set-GitHubEnvironment.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubEnvironment { +filter Set-GitHubEnvironment { <# .SYNOPSIS Create or update an environment. diff --git a/src/functions/public/Git/Get-GitHubGitConfig.ps1 b/src/functions/public/Git/Get-GitHubGitConfig.ps1 index 8b56fba2b..22fc3124f 100644 --- a/src/functions/public/Git/Get-GitHubGitConfig.ps1 +++ b/src/functions/public/Git/Get-GitHubGitConfig.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubGitConfig { +function Get-GitHubGitConfig { <# .SYNOPSIS Gets the global Git configuration. diff --git a/src/functions/public/Git/Set-GitHubGitConfig.ps1 b/src/functions/public/Git/Set-GitHubGitConfig.ps1 index 901d6bea7..a9b1d3387 100644 --- a/src/functions/public/Git/Set-GitHubGitConfig.ps1 +++ b/src/functions/public/Git/Set-GitHubGitConfig.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubGitConfig { +function Set-GitHubGitConfig { <# .SYNOPSIS Set the Git configuration for the GitHub context. diff --git a/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 b/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 index 50ad963a8..86d86a4af 100644 --- a/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 +++ b/src/functions/public/Gitignore/Get-GitHubGitignore.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubGitignore { +filter Get-GitHubGitignore { <# .SYNOPSIS Get a gitignore template or list of all gitignore templates names diff --git a/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 b/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 index 0d0c7803e..ba07446e5 100644 --- a/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 +++ b/src/functions/public/Issues/ConvertFrom-IssueForm.ps1 @@ -1,4 +1,4 @@ -function ConvertFrom-IssueForm { +function ConvertFrom-IssueForm { <# .SYNOPSIS Converts the issue form content into a hashtable or object. diff --git a/src/functions/public/License/Get-GitHubLicense.ps1 b/src/functions/public/License/Get-GitHubLicense.ps1 index 72a568495..3e21c4162 100644 --- a/src/functions/public/License/Get-GitHubLicense.ps1 +++ b/src/functions/public/License/Get-GitHubLicense.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubLicense { +filter Get-GitHubLicense { <# .SYNOPSIS Get a license template, list of all popular license templates or a license for a repository diff --git a/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 b/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 index e644c96a5..5f31bfec9 100644 --- a/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 +++ b/src/functions/public/Markdown/Get-GitHubMarkdown.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMarkdown { +filter Get-GitHubMarkdown { <# .SYNOPSIS Render a Markdown document diff --git a/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 b/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 index 472210353..bf681e0fa 100644 --- a/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 +++ b/src/functions/public/Markdown/Get-GitHubMarkdownRaw.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMarkdownRaw { +filter Get-GitHubMarkdownRaw { <# .SYNOPSIS Render a Markdown document in raw mode diff --git a/src/functions/public/Meta/Get-GitHubApiVersion.ps1 b/src/functions/public/Meta/Get-GitHubApiVersion.ps1 index 5f66726f2..e3ba1b0b9 100644 --- a/src/functions/public/Meta/Get-GitHubApiVersion.ps1 +++ b/src/functions/public/Meta/Get-GitHubApiVersion.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubApiVersion { +filter Get-GitHubApiVersion { <# .SYNOPSIS Get all API versions. diff --git a/src/functions/public/Meta/Get-GitHubMeta.ps1 b/src/functions/public/Meta/Get-GitHubMeta.ps1 index 7f1c2d802..d4d794715 100644 --- a/src/functions/public/Meta/Get-GitHubMeta.ps1 +++ b/src/functions/public/Meta/Get-GitHubMeta.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubMeta { +filter Get-GitHubMeta { <# .SYNOPSIS Get GitHub meta information. diff --git a/src/functions/public/Meta/Get-GitHubOctocat.ps1 b/src/functions/public/Meta/Get-GitHubOctocat.ps1 index 815d2592c..f610cc598 100644 --- a/src/functions/public/Meta/Get-GitHubOctocat.ps1 +++ b/src/functions/public/Meta/Get-GitHubOctocat.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubOctocat { +filter Get-GitHubOctocat { <# .SYNOPSIS Get Octocat. diff --git a/src/functions/public/Meta/Get-GitHubRoot.ps1 b/src/functions/public/Meta/Get-GitHubRoot.ps1 index 347fbb26c..f278121fe 100644 --- a/src/functions/public/Meta/Get-GitHubRoot.ps1 +++ b/src/functions/public/Meta/Get-GitHubRoot.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRoot { +filter Get-GitHubRoot { <# .SYNOPSIS GitHub API Root. diff --git a/src/functions/public/Meta/Get-GitHubZen.ps1 b/src/functions/public/Meta/Get-GitHubZen.ps1 index d2a924549..53e19effd 100644 --- a/src/functions/public/Meta/Get-GitHubZen.ps1 +++ b/src/functions/public/Meta/Get-GitHubZen.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubZen { +filter Get-GitHubZen { <# .SYNOPSIS Get the Zen of GitHub. diff --git a/src/functions/public/Organization/Get-GitHubOrganization.ps1 b/src/functions/public/Organization/Get-GitHubOrganization.ps1 index 19fe46a12..3c19b628a 100644 --- a/src/functions/public/Organization/Get-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Get-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubOrganization { +filter Get-GitHubOrganization { <# .SYNOPSIS List organization diff --git a/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 b/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 index 92d013c19..4c6bbb099 100644 --- a/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 +++ b/src/functions/public/Organization/Members/Get-GitHubOrganizationPendingInvitation.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubOrganizationPendingInvitation { +function Get-GitHubOrganizationPendingInvitation { <# .SYNOPSIS List pending organization invitations diff --git a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 index 0c3eb9347..09a976623 100644 --- a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 @@ -1,4 +1,4 @@ -function New-GitHubOrganizationInvitation { +function New-GitHubOrganizationInvitation { <# .SYNOPSIS Create an organization invitation diff --git a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 index 434412e37..5b2fe5871 100644 --- a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubOrganizationInvitation { +function Remove-GitHubOrganizationInvitation { <# .SYNOPSIS Cancel an organization invitation diff --git a/src/functions/public/Organization/New-GitHubOrganization.ps1 b/src/functions/public/Organization/New-GitHubOrganization.ps1 index 29f1386a6..74627dba1 100644 --- a/src/functions/public/Organization/New-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/New-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -function New-GitHubOrganization { +function New-GitHubOrganization { <# .SYNOPSIS Creates a new GitHub organization within a specified enterprise. diff --git a/src/functions/public/Organization/Remove-GitHubOrganization.ps1 b/src/functions/public/Organization/Remove-GitHubOrganization.ps1 index 952796971..48ee1ef64 100644 --- a/src/functions/public/Organization/Remove-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Remove-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubOrganization { +filter Remove-GitHubOrganization { <# .SYNOPSIS Delete an organization diff --git a/src/functions/public/Organization/Update-GitHubOrganization.ps1 b/src/functions/public/Organization/Update-GitHubOrganization.ps1 index 6110e5593..3169dd79a 100644 --- a/src/functions/public/Organization/Update-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/Update-GitHubOrganization.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubOrganization { +filter Update-GitHubOrganization { <# .SYNOPSIS Update an organization diff --git a/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 b/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 index 6629d07f1..31d1f1ff0 100644 --- a/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 +++ b/src/functions/public/Rate-Limit/Get-GitHubRateLimit.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRateLimit { +filter Get-GitHubRateLimit { <# .SYNOPSIS Get rate limit status for the authenticated user diff --git a/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 index e978a6467..eaf3c7be7 100644 --- a/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Add-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubReleaseAsset { +filter Add-GitHubReleaseAsset { <# .SYNOPSIS Upload a release asset diff --git a/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 index 4e0bb47d4..e0d2c5137 100644 --- a/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Get-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubReleaseAsset { +filter Get-GitHubReleaseAsset { <# .SYNOPSIS List release assets based on a release ID, asset ID, or asset name diff --git a/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 index 8a831d6bb..64d53944a 100644 --- a/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Remove-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubReleaseAsset { +filter Remove-GitHubReleaseAsset { <# .SYNOPSIS Delete a release asset diff --git a/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 index 291f2f7c6..8876b5aa5 100644 --- a/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Save-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -function Save-GitHubReleaseAsset { +function Save-GitHubReleaseAsset { <# .SYNOPSIS Downloads a GitHub Release asset. diff --git a/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 b/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 index f84ddcd45..a5f6d519b 100644 --- a/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 +++ b/src/functions/public/Releases/Assets/Update-GitHubReleaseAsset.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubReleaseAsset { +filter Update-GitHubReleaseAsset { <# .SYNOPSIS Update a release asset diff --git a/src/functions/public/Releases/Get-GitHubRelease.ps1 b/src/functions/public/Releases/Get-GitHubRelease.ps1 index f8d477141..36cb1e0fa 100644 --- a/src/functions/public/Releases/Get-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Get-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRelease { +filter Get-GitHubRelease { <# .SYNOPSIS Retrieves GitHub release information for a repository. diff --git a/src/functions/public/Releases/New-GitHubRelease.ps1 b/src/functions/public/Releases/New-GitHubRelease.ps1 index ebd213a63..275b3abe9 100644 --- a/src/functions/public/Releases/New-GitHubRelease.ps1 +++ b/src/functions/public/Releases/New-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRelease { +filter New-GitHubRelease { <# .SYNOPSIS Create a release diff --git a/src/functions/public/Releases/New-GitHubReleaseNote.ps1 b/src/functions/public/Releases/New-GitHubReleaseNote.ps1 index f50d995ad..fe07d0233 100644 --- a/src/functions/public/Releases/New-GitHubReleaseNote.ps1 +++ b/src/functions/public/Releases/New-GitHubReleaseNote.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubReleaseNote { +filter New-GitHubReleaseNote { <# .SYNOPSIS Generate release notes content for a release. diff --git a/src/functions/public/Releases/Remove-GitHubRelease.ps1 b/src/functions/public/Releases/Remove-GitHubRelease.ps1 index ab7b47e81..1ad90ecfd 100644 --- a/src/functions/public/Releases/Remove-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Remove-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubRelease { +filter Remove-GitHubRelease { <# .SYNOPSIS Delete a release diff --git a/src/functions/public/Releases/Set-GitHubRelease.ps1 b/src/functions/public/Releases/Set-GitHubRelease.ps1 index c920e9d7a..f11f55055 100644 --- a/src/functions/public/Releases/Set-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Set-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubRelease { +filter Set-GitHubRelease { <# .SYNOPSIS Creates or updates a release. diff --git a/src/functions/public/Releases/Update-GitHubRelease.ps1 b/src/functions/public/Releases/Update-GitHubRelease.ps1 index 83090ec49..4671e3519 100644 --- a/src/functions/public/Releases/Update-GitHubRelease.ps1 +++ b/src/functions/public/Releases/Update-GitHubRelease.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubRelease { +filter Update-GitHubRelease { <# .SYNOPSIS Update a release diff --git a/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 index 6605821ab..3f4d7b96c 100644 --- a/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/Get-GitHubRepositoryAutolink.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryAutolink { +filter Get-GitHubRepositoryAutolink { <# .SYNOPSIS List all autolinks of a repository diff --git a/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 index 9e7c64bc7..f4e72a598 100644 --- a/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/New-GitHubRepositoryAutolink.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepositoryAutolink { +filter New-GitHubRepositoryAutolink { <# .SYNOPSIS Create an autolink reference for a repository diff --git a/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 b/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 index 18d328c1f..ced19d6fa 100644 --- a/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 +++ b/src/functions/public/Repositories/Autolinks/Remove-GitHubRepositoryAutolink.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubRepositoryAutolink { +filter Remove-GitHubRepositoryAutolink { <# .SYNOPSIS Delete an autolink reference from a repository diff --git a/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 b/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 index 695a22674..8bb6371a2 100644 --- a/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 +++ b/src/functions/public/Repositories/CustomProperties/Get-GitHubRepositoryCustomProperty.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryCustomProperty { +filter Get-GitHubRepositoryCustomProperty { <# .SYNOPSIS Get all custom property values for a repository diff --git a/src/functions/public/Repositories/Get-GitHubRepository.ps1 b/src/functions/public/Repositories/Get-GitHubRepository.ps1 index 5da385798..b37278a77 100644 --- a/src/functions/public/Repositories/Get-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Get-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepository { +filter Get-GitHubRepository { <# .SYNOPSIS Gets a specific repository or list of repositories. diff --git a/src/functions/public/Repositories/Move-GitHubRepository.ps1 b/src/functions/public/Repositories/Move-GitHubRepository.ps1 index dceb15e60..69f5f0951 100644 --- a/src/functions/public/Repositories/Move-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Move-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Move-GitHubRepository { +filter Move-GitHubRepository { <# .SYNOPSIS Transfer a repository diff --git a/src/functions/public/Repositories/New-GitHubRepository.ps1 b/src/functions/public/Repositories/New-GitHubRepository.ps1 index 2f16be59c..38ab5f58c 100644 --- a/src/functions/public/Repositories/New-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/New-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter New-GitHubRepository { +filter New-GitHubRepository { <# .SYNOPSIS Create a repository for a user or an organization. diff --git a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 index 1f8703f71..d2680a87e 100644 --- a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryPermission { +filter Get-GitHubRepositoryPermission { <# .SYNOPSIS Get the permission level for a team on a repository. diff --git a/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 index e73407fea..b5af706fd 100644 --- a/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Remove-GitHubRepositoryPermission.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubRepositoryPermission { +filter Remove-GitHubRepositoryPermission { <# .SYNOPSIS Remove the permission level for a team on a repository. diff --git a/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 index aa683dd50..d03437497 100644 --- a/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Set-GitHubRepositoryPermission.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubRepositoryPermission { +filter Set-GitHubRepositoryPermission { <# .SYNOPSIS Set the permission level for a team on a repository diff --git a/src/functions/public/Repositories/Remove-GitHubRepository.ps1 b/src/functions/public/Repositories/Remove-GitHubRepository.ps1 index 16ed92527..d70111d92 100644 --- a/src/functions/public/Repositories/Remove-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Remove-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubRepository { +filter Remove-GitHubRepository { <# .SYNOPSIS Delete a repository diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 index 91018c32e..9240228a0 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubRepositoryPrivateVulnerabilityReporting { +filter Disable-GitHubRepositoryPrivateVulnerabilityReporting { <# .SYNOPSIS Disable private vulnerability reporting for a repository diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 index 7d2051c27..b8df36bcf 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositorySecurityFix.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubRepositorySecurityFix { +filter Disable-GitHubRepositorySecurityFix { <# .SYNOPSIS Disable automated security fixes diff --git a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 index 7dbf6d94f..0d1cc5a39 100644 --- a/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Disable-GitHubRepositoryVulnerabilityAlert.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubRepositoryVulnerabilityAlert { +filter Disable-GitHubRepositoryVulnerabilityAlert { <# .SYNOPSIS Disable vulnerability alerts diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 index a23ff4135..6f59ebceb 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryPrivateVulnerabilityReporting.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubRepositoryPrivateVulnerabilityReporting { +filter Enable-GitHubRepositoryPrivateVulnerabilityReporting { <# .SYNOPSIS Enable private vulnerability reporting for a repository diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 index cad08f16a..8b84b61fd 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositorySecurityFix.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubRepositorySecurityFix { +filter Enable-GitHubRepositorySecurityFix { <# .SYNOPSIS Enable automated security fixes diff --git a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 index e348e86a9..7802a2f8e 100644 --- a/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Enable-GitHubRepositoryVulnerabilityAlert.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubRepositoryVulnerabilityAlert { +filter Enable-GitHubRepositoryVulnerabilityAlert { <# .SYNOPSIS Enable vulnerability alerts diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 index 80e981284..dd43ec0b7 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryActivity.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryActivity { +filter Get-GitHubRepositoryActivity { <# .SYNOPSIS List repository activities diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 index 91e190e16..efec4e854 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryCodeownersError.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryCodeownersError { +filter Get-GitHubRepositoryCodeownersError { <# .SYNOPSIS List CODEOWNERS errors diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 index ae3301c9a..46d7fb7c6 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryContributor.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryContributor { +filter Get-GitHubRepositoryContributor { <# .SYNOPSIS List repository contributors diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 index 10011cf63..fcca625f4 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryFork.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryFork { +filter Get-GitHubRepositoryFork { <# .SYNOPSIS List forks diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 index 7a811eef8..b5c84d25e 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryLanguage.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryLanguage { +filter Get-GitHubRepositoryLanguage { <# .SYNOPSIS List repository languages diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 index 1374df856..7c08886a1 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositorySecurityFix.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositorySecurityFix { +filter Get-GitHubRepositorySecurityFix { <# .SYNOPSIS Check if automated security fixes are enabled for a repository diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 index f26e5503b..6ee76facb 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTag.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryTag { +filter Get-GitHubRepositoryTag { <# .SYNOPSIS List repository tags diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 index 488084bc7..220481bd6 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTeam.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryTeam { +filter Get-GitHubRepositoryTeam { <# .SYNOPSIS List repository teams diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 index 388b551cd..de80b74e2 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryTopic { +filter Get-GitHubRepositoryTopic { <# .SYNOPSIS Get all repository topics diff --git a/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 index b3af72fb3..f06061d0a 100644 --- a/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 +++ b/src/functions/public/Repositories/Repositories/Set-GitHubRepositoryTopic.ps1 @@ -1,4 +1,4 @@ -filter Set-GitHubRepositoryTopic { +filter Set-GitHubRepositoryTopic { <# .SYNOPSIS Replace all repository topics diff --git a/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 b/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 index 7ecf7b212..ab6fecced 100644 --- a/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 +++ b/src/functions/public/Repositories/Repositories/Start-GitHubRepositoryEvent.ps1 @@ -1,4 +1,4 @@ -filter Start-GitHubRepositoryEvent { +filter Start-GitHubRepositoryEvent { <# .SYNOPSIS Create a repository dispatch event diff --git a/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 b/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 index ae4d32734..c23fe55ed 100644 --- a/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 +++ b/src/functions/public/Repositories/Repositories/Test-GitHubRepositoryVulnerabilityAlert.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubRepositoryVulnerabilityAlert { +filter Test-GitHubRepositoryVulnerabilityAlert { <# .SYNOPSIS Check if vulnerability alerts are enabled for a repository diff --git a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 index 2d77f67ff..b96dcee57 100644 --- a/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 +++ b/src/functions/public/Repositories/RuleSuite/Get-GitHubRepositoryRuleSuite.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubRepositoryRuleSuite { +filter Get-GitHubRepositoryRuleSuite { <# .SYNOPSIS List repository rule suites or a rule suite by ID. diff --git a/src/functions/public/Repositories/Set-GitHubRepository.ps1 b/src/functions/public/Repositories/Set-GitHubRepository.ps1 index 595d2670e..96e30b43e 100644 --- a/src/functions/public/Repositories/Set-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Set-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubRepository { +function Set-GitHubRepository { <# .SYNOPSIS Creates or updates a repository. diff --git a/src/functions/public/Repositories/Update-GitHubRepository.ps1 b/src/functions/public/Repositories/Update-GitHubRepository.ps1 index f221cd902..e714e5c3f 100644 --- a/src/functions/public/Repositories/Update-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Update-GitHubRepository.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubRepository { +filter Update-GitHubRepository { <# .SYNOPSIS Update a repository diff --git a/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 b/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 index 6bcc7504a..6e03ff368 100644 --- a/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 +++ b/src/functions/public/Secrets/Get-GitHubPublicKey.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubPublicKey { +function Get-GitHubPublicKey { <# .SYNOPSIS Gets a public key. diff --git a/src/functions/public/Secrets/Get-GitHubSecret.ps1 b/src/functions/public/Secrets/Get-GitHubSecret.ps1 index c727b5b94..899466e44 100644 --- a/src/functions/public/Secrets/Get-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Get-GitHubSecret.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecret { +function Get-GitHubSecret { <# .SYNOPSIS Retrieve GitHub secret(s) without revealing encrypted value(s). diff --git a/src/functions/public/Secrets/Remove-GitHubSecret.ps1 b/src/functions/public/Secrets/Remove-GitHubSecret.ps1 index e93e67315..0d0aa5bd7 100644 --- a/src/functions/public/Secrets/Remove-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Remove-GitHubSecret.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecret { +function Remove-GitHubSecret { <# .SYNOPSIS Deletes a secret from GitHub. diff --git a/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 index 3e9782ee4..0d7f260c0 100644 --- a/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Add-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubSecretSelectedRepository { +function Add-GitHubSecretSelectedRepository { <# .SYNOPSIS Add selected repository to an organization secret. diff --git a/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 index 33992634d..a2f1aec95 100644 --- a/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Get-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubSecretSelectedRepository { +function Get-GitHubSecretSelectedRepository { <# .SYNOPSIS List selected repositories for an organization secret. diff --git a/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 index f27f1161d..fa3a95f6a 100644 --- a/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Remove-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubSecretSelectedRepository { +function Remove-GitHubSecretSelectedRepository { <# .SYNOPSIS Remove selected repository from an organization secret. diff --git a/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 b/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 index 465335067..e8ad87c82 100644 --- a/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 +++ b/src/functions/public/Secrets/SelectedRepository/Set-GitHubSecretSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecretSelectedRepository { +function Set-GitHubSecretSelectedRepository { <# .SYNOPSIS Set selected repositories for an organization secret. diff --git a/src/functions/public/Secrets/Set-GitHubSecret.ps1 b/src/functions/public/Secrets/Set-GitHubSecret.ps1 index da67d831b..c622abc46 100644 --- a/src/functions/public/Secrets/Set-GitHubSecret.ps1 +++ b/src/functions/public/Secrets/Set-GitHubSecret.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubSecret { +function Set-GitHubSecret { <# .SYNOPSIS Updates a GitHub secret for an organization, repository, or user. diff --git a/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 b/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 index d78da0f2a..cdf08cde3 100644 --- a/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 +++ b/src/functions/public/Status/Get-GitHubScheduledMaintenance.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubScheduledMaintenance { +function Get-GitHubScheduledMaintenance { <# .SYNOPSIS Gets the status of GitHub scheduled maintenance diff --git a/src/functions/public/Status/Get-GitHubStatus.ps1 b/src/functions/public/Status/Get-GitHubStatus.ps1 index 5325d4948..94ac1dec6 100644 --- a/src/functions/public/Status/Get-GitHubStatus.ps1 +++ b/src/functions/public/Status/Get-GitHubStatus.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubStatus { +function Get-GitHubStatus { <# .SYNOPSIS Gets the status of GitHub services diff --git a/src/functions/public/Status/Get-GitHubStatusComponent.ps1 b/src/functions/public/Status/Get-GitHubStatusComponent.ps1 index be769e247..10d341740 100644 --- a/src/functions/public/Status/Get-GitHubStatusComponent.ps1 +++ b/src/functions/public/Status/Get-GitHubStatusComponent.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubStatusComponent { +function Get-GitHubStatusComponent { <# .SYNOPSIS Gets the status of GitHub components diff --git a/src/functions/public/Status/Get-GitHubStatusIncident.ps1 b/src/functions/public/Status/Get-GitHubStatusIncident.ps1 index 6e7cad880..fc89706de 100644 --- a/src/functions/public/Status/Get-GitHubStatusIncident.ps1 +++ b/src/functions/public/Status/Get-GitHubStatusIncident.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubStatusIncident { +function Get-GitHubStatusIncident { <# .SYNOPSIS Gets the status of GitHub incidents diff --git a/src/functions/public/Teams/Get-GitHubTeam.ps1 b/src/functions/public/Teams/Get-GitHubTeam.ps1 index 71b414700..425f5df65 100644 --- a/src/functions/public/Teams/Get-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Get-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubTeam { +function Get-GitHubTeam { <# .SYNOPSIS List teams from an org or get a team by name diff --git a/src/functions/public/Teams/New-GitHubTeam.ps1 b/src/functions/public/Teams/New-GitHubTeam.ps1 index 3882993e3..58bf83596 100644 --- a/src/functions/public/Teams/New-GitHubTeam.ps1 +++ b/src/functions/public/Teams/New-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function New-GitHubTeam { +function New-GitHubTeam { <# .SYNOPSIS Create a team diff --git a/src/functions/public/Teams/Remove-GitHubTeam.ps1 b/src/functions/public/Teams/Remove-GitHubTeam.ps1 index 2defb769b..c95fa09b2 100644 --- a/src/functions/public/Teams/Remove-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Remove-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubTeam { +function Remove-GitHubTeam { <# .SYNOPSIS Delete a team diff --git a/src/functions/public/Teams/Update-GitHubTeam.ps1 b/src/functions/public/Teams/Update-GitHubTeam.ps1 index 1600119ce..fe12bb107 100644 --- a/src/functions/public/Teams/Update-GitHubTeam.ps1 +++ b/src/functions/public/Teams/Update-GitHubTeam.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubTeam { +function Update-GitHubTeam { <# .SYNOPSIS Update a team diff --git a/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 b/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 index 2afa83c9b..600d750a2 100644 --- a/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 +++ b/src/functions/public/Users/Blocking/Block-GitHubUser.ps1 @@ -1,4 +1,4 @@ -filter Block-GitHubUser { +filter Block-GitHubUser { <# .SYNOPSIS Block a user from user or an organization. diff --git a/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 index 8dad681be..5be098951 100644 --- a/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 +++ b/src/functions/public/Users/Blocking/Get-GitHubBlockedUser.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubBlockedUser { +filter Get-GitHubBlockedUser { <# .SYNOPSIS List blocked users. diff --git a/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 b/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 index 84332aa9c..0d876e061 100644 --- a/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 +++ b/src/functions/public/Users/Blocking/Test-GitHubBlockedUser.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubBlockedUser { +filter Test-GitHubBlockedUser { <# .SYNOPSIS Check if a user is blocked by the authenticated user or an organization. diff --git a/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 b/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 index d770801e2..f242b36e1 100644 --- a/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 +++ b/src/functions/public/Users/Blocking/Unblock-GitHubUser.ps1 @@ -1,4 +1,4 @@ -filter Unblock-GitHubUser { +filter Unblock-GitHubUser { <# .SYNOPSIS Unblock a user diff --git a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 index 6723ba8d3..b108b5ddd 100644 --- a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserEmail { +filter Add-GitHubUserEmail { <# .SYNOPSIS Add an email address for the authenticated user diff --git a/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 index 1e0c50e18..55762c404 100644 --- a/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Get-GitHubUserEmail.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserEmail { +filter Get-GitHubUserEmail { <# .SYNOPSIS List email addresses for the authenticated user diff --git a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 index 4bef87f50..6d3fdd4b7 100644 --- a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserEmail { +filter Remove-GitHubUserEmail { <# .SYNOPSIS Delete an email address for the authenticated user diff --git a/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 b/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 index 6d51fd28b..a849dccce 100644 --- a/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 +++ b/src/functions/public/Users/Emails/Update-GitHubUserEmailVisibility.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubUserEmailVisibility { +filter Update-GitHubUserEmailVisibility { <# .SYNOPSIS Set primary email visibility for the authenticated user diff --git a/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 index 07a6c299a..94d778a6a 100644 --- a/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Add-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserFollowing { +filter Add-GitHubUserFollowing { <# .SYNOPSIS Follow a user diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 index 46a398005..f0054161b 100644 --- a/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 +++ b/src/functions/public/Users/Followers/Get-GitHubUserFollower.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollower { +filter Get-GitHubUserFollower { <# .SYNOPSIS List followers of a given user or the authenticated user diff --git a/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 index 15b1cf866..c60c6678c 100644 --- a/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Get-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserFollowing { +filter Get-GitHubUserFollowing { <# .SYNOPSIS List the people a given user or the authenticated user follows diff --git a/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 index 6e603994e..56f6ec2b6 100644 --- a/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Remove-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserFollowing { +filter Remove-GitHubUserFollowing { <# .SYNOPSIS Unfollow a user diff --git a/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 b/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 index 76a425855..70534827d 100644 --- a/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 +++ b/src/functions/public/Users/Followers/Test-GitHubUserFollowing.ps1 @@ -1,4 +1,4 @@ -filter Test-GitHubUserFollowing { +filter Test-GitHubUserFollowing { <# .SYNOPSIS Check if a given user or the authenticated user follows a person diff --git a/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 index fa91c5789..599735083 100644 --- a/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Add-GitHubUserGpgKey.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserGpgKey { +filter Add-GitHubUserGpgKey { <# .SYNOPSIS Create a GPG key for the authenticated user diff --git a/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 index d5512209c..7c136b13b 100644 --- a/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Get-GitHubUserGpgKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserGpgKey { +filter Get-GitHubUserGpgKey { <# .SYNOPSIS List GPG keys for a given user or the authenticated user diff --git a/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 b/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 index f0008b921..ee54e70e0 100644 --- a/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 +++ b/src/functions/public/Users/GPG-Keys/Remove-GitHubUserGpgKey.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserGpgKey { +filter Remove-GitHubUserGpgKey { <# .SYNOPSIS Delete a GPG key for the authenticated user diff --git a/src/functions/public/Users/Get-GitHubUser.ps1 b/src/functions/public/Users/Get-GitHubUser.ps1 index 36770cabb..e7fe41c15 100644 --- a/src/functions/public/Users/Get-GitHubUser.ps1 +++ b/src/functions/public/Users/Get-GitHubUser.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubUser { +function Get-GitHubUser { <# .SYNOPSIS List user(s) diff --git a/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 index d22420b55..e3e99bb0d 100644 --- a/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Add-GitHubUserKey.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserKey { +filter Add-GitHubUserKey { <# .SYNOPSIS Create a public SSH key for the authenticated user diff --git a/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 index dee22e785..113561613 100644 --- a/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Get-GitHubUserKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserKey { +filter Get-GitHubUserKey { <# .SYNOPSIS List public SSH keys for a given user or the authenticated user. diff --git a/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 b/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 index 230816240..efd37ffc1 100644 --- a/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 +++ b/src/functions/public/Users/Keys/Remove-GitHubUserKey.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserKey { +filter Remove-GitHubUserKey { <# .SYNOPSIS Delete a public SSH key for the authenticated user diff --git a/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 index 973c44391..75336526b 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Add-GitHubUserSigningKey.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserSigningKey { +filter Add-GitHubUserSigningKey { <# .SYNOPSIS Create a SSH signing key for the authenticated user diff --git a/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 index f44592342..43e4bb241 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Get-GitHubUserSigningKey.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubUserSigningKey { +filter Get-GitHubUserSigningKey { <# .SYNOPSIS List SSH signing keys for a given user or the authenticated user. diff --git a/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 b/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 index 123608b6d..6689e6125 100644 --- a/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 +++ b/src/functions/public/Users/SSH-Signing-Keys/Remove-GitHubUserSigningKey.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserSigningKey { +filter Remove-GitHubUserSigningKey { <# .SYNOPSIS Delete an SSH signing key for the authenticated user diff --git a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 index 0d57399cb..e54c1ded1 100644 --- a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 @@ -1,4 +1,4 @@ -filter Add-GitHubUserSocial { +filter Add-GitHubUserSocial { <# .SYNOPSIS Add social accounts for the authenticated user diff --git a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 index 071cde62c..301673819 100644 --- a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubUserSocial { +filter Remove-GitHubUserSocial { <# .SYNOPSIS Delete social accounts for the authenticated user diff --git a/src/functions/public/Users/Update-GitHubUser.ps1 b/src/functions/public/Users/Update-GitHubUser.ps1 index 4a8997d03..c6b29121a 100644 --- a/src/functions/public/Users/Update-GitHubUser.ps1 +++ b/src/functions/public/Users/Update-GitHubUser.ps1 @@ -1,4 +1,4 @@ -filter Update-GitHubUser { +filter Update-GitHubUser { <# .SYNOPSIS Update the authenticated user diff --git a/src/functions/public/Variables/Export-GitHubVariable.ps1 b/src/functions/public/Variables/Export-GitHubVariable.ps1 index 83af9b303..744d24977 100644 --- a/src/functions/public/Variables/Export-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Export-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Export-GitHubVariable { +function Export-GitHubVariable { <# .SYNOPSIS Exports a GitHub variable to the local environment. diff --git a/src/functions/public/Variables/Get-GitHubVariable.ps1 b/src/functions/public/Variables/Get-GitHubVariable.ps1 index 6006e3e0c..9f1c09088 100644 --- a/src/functions/public/Variables/Get-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Get-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariable { +function Get-GitHubVariable { <# .SYNOPSIS Retrieves a variable from GitHub based on the specified scope. diff --git a/src/functions/public/Variables/New-GitHubVariable.ps1 b/src/functions/public/Variables/New-GitHubVariable.ps1 index a4bb5a00b..5ecaf5d5c 100644 --- a/src/functions/public/Variables/New-GitHubVariable.ps1 +++ b/src/functions/public/Variables/New-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function New-GitHubVariable { +function New-GitHubVariable { <# .SYNOPSIS Creates a GitHub Actions variable at the organization, repository, or environment level. diff --git a/src/functions/public/Variables/Remove-GitHubVariable.ps1 b/src/functions/public/Variables/Remove-GitHubVariable.ps1 index e0cb2cd7a..b3758fac4 100644 --- a/src/functions/public/Variables/Remove-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Remove-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariable { +function Remove-GitHubVariable { <# .SYNOPSIS Deletes a GitHub variable from an organization, repository, or environment. diff --git a/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 index 884f788c0..f8362ffbb 100644 --- a/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Add-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Add-GitHubVariableSelectedRepository { +function Add-GitHubVariableSelectedRepository { <# .SYNOPSIS Add selected repository to an organization variable. diff --git a/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 index 5afbcedfe..86cf75ed1 100644 --- a/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Get-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubVariableSelectedRepository { +function Get-GitHubVariableSelectedRepository { <# .SYNOPSIS List selected repositories for an organization variable. diff --git a/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 index f3b1dd656..ceb4201f7 100644 --- a/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Remove-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Remove-GitHubVariableSelectedRepository { +function Remove-GitHubVariableSelectedRepository { <# .SYNOPSIS Remove selected repository from an organization variable. diff --git a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 index b75a0c309..49410182f 100644 --- a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubVariableSelectedRepository { +function Set-GitHubVariableSelectedRepository { <# .SYNOPSIS Set selected repositories for an organization variable. diff --git a/src/functions/public/Variables/Set-GitHubVariable.ps1 b/src/functions/public/Variables/Set-GitHubVariable.ps1 index d2ab74d0a..8d87264a8 100644 --- a/src/functions/public/Variables/Set-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Set-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Set-GitHubVariable { +function Set-GitHubVariable { <# .SYNOPSIS Creates or updates a GitHub Actions variable at the organization, repository, or environment level. diff --git a/src/functions/public/Variables/Update-GitHubVariable.ps1 b/src/functions/public/Variables/Update-GitHubVariable.ps1 index 84deec91a..568eadcc7 100644 --- a/src/functions/public/Variables/Update-GitHubVariable.ps1 +++ b/src/functions/public/Variables/Update-GitHubVariable.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubVariable { +function Update-GitHubVariable { <# .SYNOPSIS Update a GitHub variable at the organization, repository, or environment level. diff --git a/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 index 4b9b0e9c7..22dedc17e 100644 --- a/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Get-GitHubAppWebhookConfiguration.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookConfiguration { +function Get-GitHubAppWebhookConfiguration { <# .SYNOPSIS Get a webhook configuration for an app diff --git a/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 b/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 index 5ebd6acee..40cf9244d 100644 --- a/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 +++ b/src/functions/public/Webhooks/Get-GitHubAppWebhookDelivery.ps1 @@ -1,4 +1,4 @@ -function Get-GitHubAppWebhookDelivery { +function Get-GitHubAppWebhookDelivery { <# .SYNOPSIS List deliveries for an app webhook or get a delivery for an app webhook by ID. diff --git a/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 b/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 index a01692b23..3866df748 100644 --- a/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 +++ b/src/functions/public/Webhooks/Invoke-GitHubAppWebhookReDelivery.ps1 @@ -1,4 +1,4 @@ -function Invoke-GitHubAppWebhookReDelivery { +function Invoke-GitHubAppWebhookReDelivery { <# .SYNOPSIS Redeliver a delivery for an app webhook diff --git a/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 b/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 index 934b6152b..e0f78da55 100644 --- a/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 +++ b/src/functions/public/Webhooks/Test-GitHubWebhookSignature.ps1 @@ -1,4 +1,4 @@ -function Test-GitHubWebhookSignature { +function Test-GitHubWebhookSignature { <# .SYNOPSIS Verifies a GitHub webhook signature using a shared secret. diff --git a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 index 17ae034bb..642f9ed82 100644 --- a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 @@ -1,4 +1,4 @@ -function Update-GitHubAppWebhookConfiguration { +function Update-GitHubAppWebhookConfiguration { <# .SYNOPSIS Update a webhook configuration for an app diff --git a/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 index 8ebdfe640..040394953 100644 --- a/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Disable-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Disable-GitHubWorkflow { +filter Disable-GitHubWorkflow { <# .SYNOPSIS Disable a workflow. diff --git a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 index 963fdb544..9605acad2 100644 --- a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Enable-GitHubWorkflow { +filter Enable-GitHubWorkflow { <# .SYNOPSIS Enable a workflow diff --git a/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 index dfa6d607e..eac6c217b 100644 --- a/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Get-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflow { +filter Get-GitHubWorkflow { <# .SYNOPSIS Lists the workflows in a repository. diff --git a/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 index 417c1f452..aa969ee54 100644 --- a/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Get-GitHubWorkflowRun.ps1 @@ -1,4 +1,4 @@ -filter Get-GitHubWorkflowRun { +filter Get-GitHubWorkflowRun { <# .SYNOPSIS List workflow runs for a repository or a workflow diff --git a/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 index 5284787eb..1be51bea9 100644 --- a/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Remove-GitHubWorkflowRun.ps1 @@ -1,4 +1,4 @@ -filter Remove-GitHubWorkflowRun { +filter Remove-GitHubWorkflowRun { <# .SYNOPSIS Delete a workflow run diff --git a/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 index 05012b2b3..766371fab 100644 --- a/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Restart-GitHubWorkflowRun.ps1 @@ -1,4 +1,4 @@ -filter Restart-GitHubWorkflowRun { +filter Restart-GitHubWorkflowRun { <# .SYNOPSIS Re-run a workflow diff --git a/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 b/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 index 24086a6f8..ccf8b5965 100644 --- a/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 +++ b/src/functions/public/Workflows/Runs/Stop-GitHubWorkflowRun.ps1 @@ -1,4 +1,4 @@ -filter Stop-GitHubWorkflowRun { +filter Stop-GitHubWorkflowRun { <# .SYNOPSIS Cancel a workflow run diff --git a/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 index ce800e80f..59d8fe9b3 100644 --- a/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Start-GitHubWorkflow.ps1 @@ -1,4 +1,4 @@ -filter Start-GitHubWorkflow { +filter Start-GitHubWorkflow { <# .SYNOPSIS Start a workflow run using the workflow's ID. diff --git a/tools/utilities/New-FunctionTemplate.ps1 b/tools/utilities/New-FunctionTemplate.ps1 index 7823e2ea9..c013af5d0 100644 --- a/tools/utilities/New-FunctionTemplate.ps1 +++ b/tools/utilities/New-FunctionTemplate.ps1 @@ -1,4 +1,4 @@ -function New-FunctionTemplate { +function New-FunctionTemplate { <# .SYNOPSIS Short description From 67282697736f999cdd78f78ee82e390e78092746 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 12:46:16 +0200 Subject: [PATCH 11/16] Fix formatting in documentation for Enable-GitHubWorkflow function --- src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 index 9605acad2..23a0bba90 100644 --- a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 @@ -5,7 +5,7 @@ .DESCRIPTION Enables a workflow and sets the `state` of the workflow to `active`. You can use workflow - file name and ID in the `ID` parameter. For example, you could use `main.yaml`. + filename and ID in the `ID` parameter. For example, you could use `main.yaml`. OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. @@ -16,7 +16,7 @@ ``` ``` - Enables the workflow with the file name 'main.yaml' in the PSModule/GitHub repository. + Enables the workflow with the filename 'main.yaml' in the PSModule/GitHub repository. .EXAMPLE ```powershell From 5b21d8d80f430bd42c6fb74ad4fe7e11daa88652 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 14:59:44 +0200 Subject: [PATCH 12/16] Fix formatting in documentation examples across multiple PowerShell functions --- src/functions/public/Commands/Start-GitHubLogGroup.ps1 | 4 ---- src/functions/public/Commands/Stop-GitHubLogGroup.ps1 | 4 ---- .../Organization/Members/New-GitHubOrganizationInvitation.ps1 | 4 ---- .../Members/Remove-GitHubOrganizationInvitation.ps1 | 2 -- src/functions/public/Organization/New-GitHubOrganization.ps1 | 2 -- src/functions/public/Repositories/Update-GitHubRepository.ps1 | 4 ---- src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 | 2 -- src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 | 2 -- .../public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 | 2 -- .../public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 | 2 -- .../public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 | 2 -- src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 | 4 ---- 12 files changed, 34 deletions(-) diff --git a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 index 212747d2b..8682bced8 100644 --- a/src/functions/public/Commands/Start-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Start-GitHubLogGroup.ps1 @@ -15,24 +15,20 @@ .EXAMPLE ```powershell - ```powershell Start-GitHubLogGroup 'MyGroup' ``` - ``` Starts a new log group named 'MyGroup'. All subsequent log output will be grouped under this expandable section until Stop-GitHubLogGroup is called. .EXAMPLE ```powershell - ```powershell Start-GitHubLogGroup 'Building application' Write-Host 'Step 1: Restoring packages' Write-Host 'Step 2: Compiling code' Write-Host 'Step 3: Running tests' Stop-GitHubLogGroup ``` - ``` Creates a collapsible log group containing the build steps. The output will appear nested under the "Building application" header in the GitHub Actions log. diff --git a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 index e9bb01d4e..9440769b2 100644 --- a/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 +++ b/src/functions/public/Commands/Stop-GitHubLogGroup.ps1 @@ -14,23 +14,19 @@ .EXAMPLE ```powershell - ```powershell Stop-GitHubLogGroup ``` - ``` Stops the current log group in GitHub Actions. .EXAMPLE ```powershell - ```powershell Start-GitHubLogGroup 'Deployment Steps' Write-Host 'Deploying to staging...' Write-Host 'Deployment complete' Stop-GitHubLogGroup Write-Host 'This output is not in the group' ``` - ``` Creates a log group for deployment steps. The final Write-Host command outputs text outside of the group since Stop-GitHubLogGroup was called. diff --git a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 index 09a976623..804a8ec17 100644 --- a/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/New-GitHubOrganizationInvitation.ps1 @@ -14,19 +14,15 @@ .EXAMPLE ```powershell - ```powershell New-GitHubOrganizationInvitation -Organization 'PSModule' -InviteeID 123456789 -Role 'admin' ``` - ``` Invites the user with the ID `12345679` to the organization `PSModule` with the role `admin`. .EXAMPLE ```powershell - ```powershell New-GitHubOrganizationInvitation -Organization 'PSModule' -Email 'user@psmodule.io' ``` - ``` Invites the user with the email `user@psmodule.io` to the organization `PSModule`. diff --git a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 index 5b2fe5871..8d9bf7781 100644 --- a/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 +++ b/src/functions/public/Organization/Members/Remove-GitHubOrganizationInvitation.ps1 @@ -10,10 +10,8 @@ .EXAMPLE ```powershell - ```powershell Remove-GitHubOrganizationInvitation -Organization 'github' -InvitationID '12345678' ``` - ``` Cancel the invitation with the ID '12345678' for the organization `github`. diff --git a/src/functions/public/Organization/New-GitHubOrganization.ps1 b/src/functions/public/Organization/New-GitHubOrganization.ps1 index 74627dba1..6fbb3bb00 100644 --- a/src/functions/public/Organization/New-GitHubOrganization.ps1 +++ b/src/functions/public/Organization/New-GitHubOrganization.ps1 @@ -8,10 +8,8 @@ .EXAMPLE ```powershell - ```powershell New-GitHubOrganization -Enterprise 'my-enterprise' -Name 'my-org' -Owner 'user1' -BillingEmail 'billing@example.com' ``` - ``` .OUTPUTS GitHubOrganization diff --git a/src/functions/public/Repositories/Update-GitHubRepository.ps1 b/src/functions/public/Repositories/Update-GitHubRepository.ps1 index e714e5c3f..592cdfa54 100644 --- a/src/functions/public/Repositories/Update-GitHubRepository.ps1 +++ b/src/functions/public/Repositories/Update-GitHubRepository.ps1 @@ -9,14 +9,11 @@ .EXAMPLE ```powershell - ```powershell Update-GitHubRepository -Name 'octocat' -Description 'Hello-World' -Homepage 'https://github.com' ``` - ``` .EXAMPLE ```powershell - ```powershell $params = @{ Owner = 'octocat' Name = 'Hello-World' @@ -26,7 +23,6 @@ } Update-GitHubRepository @params ``` - ``` Updates the repository `Hello-World` owned by `octocat` with a new name, description, and homepage URL. diff --git a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 index b108b5ddd..4c9ab4cc8 100644 --- a/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Add-GitHubUserEmail.ps1 @@ -8,10 +8,8 @@ .EXAMPLE ```powershell - ```powershell Add-GitHubUserEmail -Email 'octocat@github.com','firstname.lastname@work.com' ``` - ``` Adds the email addresses `octocat@github.com` and `firstname.lastname@work.com` to the authenticated user's account. diff --git a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 index 6d3fdd4b7..88824904d 100644 --- a/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 +++ b/src/functions/public/Users/Emails/Remove-GitHubUserEmail.ps1 @@ -8,10 +8,8 @@ .EXAMPLE ```powershell - ```powershell Remove-GitHubUserEmail -Emails 'octocat@github.com','firstname.lastname@work.com' ``` - ``` Removes the email addresses `octocat@github.com` and `firstname.lastname@work.com` from the authenticated user's account. diff --git a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 index e54c1ded1..6ec4194bb 100644 --- a/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Add-GitHubUserSocial.ps1 @@ -8,10 +8,8 @@ .EXAMPLE ```powershell - ```powershell Add-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount', 'https://www.linkedin.com/company/MyCompany' ``` - ``` Adds the Twitter and LinkedIn accounts to the authenticated user's profile. diff --git a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 index 301673819..c93ea972a 100644 --- a/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 +++ b/src/functions/public/Users/Social-Accounts/Remove-GitHubUserSocial.ps1 @@ -8,10 +8,8 @@ .EXAMPLE ```powershell - ```powershell Remove-GitHubUserSocial -AccountUrls 'https://twitter.com/MyTwitterAccount' ``` - ``` .NOTES [Delete social accounts for the authenticated user](https://docs.github.com/rest/users/social-accounts#delete-social-accounts-for-the-authenticated-user) diff --git a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 index 642f9ed82..ee6b69336 100644 --- a/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 +++ b/src/functions/public/Webhooks/Update-GitHubAppWebhookConfiguration.ps1 @@ -12,10 +12,8 @@ .EXAMPLE ```powershell - ```powershell Update-GitHubAppWebhookConfiguration -URL 'https://example.com' -ContentType 'json' -Secret 'mysecret' -EnableSsl ``` - ``` Output: ```powershell diff --git a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 index 23a0bba90..9eb9caedd 100644 --- a/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 +++ b/src/functions/public/Workflows/Enable-GitHubWorkflow.ps1 @@ -11,19 +11,15 @@ .EXAMPLE ```powershell - ```powershell Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 'main.yaml' ``` - ``` Enables the workflow with the filename 'main.yaml' in the PSModule/GitHub repository. .EXAMPLE ```powershell - ```powershell Enable-GitHubWorkflow -Owner 'PSModule' -Repository 'GitHub' -ID 161335 ``` - ``` Enables the workflow with the ID 161335 in the PSModule/GitHub repository. From 86c785134c187802cb40b7d32dd840e7bfae7fcc Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 15:39:09 +0200 Subject: [PATCH 13/16] Fix formatting in ConvertFrom-GitHubOutput documentation examples for clarity --- .../private/Commands/ConvertFrom-GitHubOutput.ps1 | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 index 8fc2eae86..a4038a3a0 100644 --- a/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 +++ b/src/functions/private/Commands/ConvertFrom-GitHubOutput.ps1 @@ -20,10 +20,14 @@ Config={"Nested":{"SubSetting":"SubValue"},"Setting1":"Value1","Setting2":2} Numbers=12345 '@ - ``` ConvertFrom-GitHubOutput -OutputContent $content + ``` + + This will convert the GitHub Actions output syntax to a PowerShell object. + Output: + ```powershell zen : something else result : @{MyOutput=Hello, World!; Status=Success} MY_VALUE : Line1 @@ -31,8 +35,7 @@ Line3 Config : {[Nested, System.Collections.Hashtable], [Setting1, Value1], [Setting2, 2]} Numbers : 12345 - - This will convert the GitHub Actions output syntax to a PowerShell object. + ``` #> [OutputType([pscustomobject])] From 79527f3ebe99fb35bfdb2fe32d037f7022f7bce3 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 16:22:06 +0200 Subject: [PATCH 14/16] Fix formatting in documentation examples for Get-GitHubRepositoryListByTeam, Get-GitHubSecretOwnerList, Get-GitHubRepositoryPermission, Get-GitHubRepositoryTopic, and Set-GitHubVariableSelectedRepository functions --- .../Repositories/Get-GitHubRepositoryListByTeam.ps1 | 4 ---- .../private/Secrets/Get-GitHubSecretOwnerList.ps1 | 4 ---- .../Permissions/Get-GitHubRepositoryPermission.ps1 | 5 ----- .../Repositories/Get-GitHubRepositoryTopic.ps1 | 10 ++++++++++ .../Set-GitHubVariableSelectedRepository.ps1 | 3 +++ 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 index f722df323..5c456d317 100644 --- a/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 +++ b/src/functions/private/Repositories/Get-GitHubRepositoryListByTeam.ps1 @@ -11,10 +11,6 @@ Get-GitHubRepositoryListByTeam -Owner 'octocat' -Team 'core' ``` - Output: - ```powershell - ``` - Lists all repositories that the 'core' team has access to in the organization owned by 'octocat'. .INPUTS diff --git a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 index 876c5a06e..3eec25c1b 100644 --- a/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 +++ b/src/functions/private/Secrets/Get-GitHubSecretOwnerList.ps1 @@ -13,10 +13,6 @@ Get-GitHubSecretOwnerList -Owner 'PSModule' -Context (Get-GitHubContext) ``` - Output: - ```powershell - ``` - Retrieves all secrets from the specified organization. .OUTPUTS diff --git a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 index d2680a87e..62812be83 100644 --- a/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 +++ b/src/functions/public/Repositories/Permissions/Get-GitHubRepositoryPermission.ps1 @@ -18,11 +18,6 @@ Retrieves the permission of the 'core' team on the 'Hello-World' repository owned by 'octocat'. - .EXAMPLE - ```powershell - ``` - - .INPUTS GitHubRepository diff --git a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 index de80b74e2..a9e2f3522 100644 --- a/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 +++ b/src/functions/public/Repositories/Repositories/Get-GitHubRepositoryTopic.ps1 @@ -8,8 +8,18 @@ .EXAMPLE ```powershell + Get-GitHubRepositoryTopic -Owner 'octocat' -Name 'Hello-World' ``` + Output: + ```powershell + topic1 + topic2 + topic3 + ``` + + Retrieves all topics for the 'Hello-World' repository owned by 'octocat'. + .NOTES [Get all repository topics](https://docs.github.com/rest/repos/repos#get-all-repository-topics) diff --git a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 index 49410182f..9dca48517 100644 --- a/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 +++ b/src/functions/public/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository.ps1 @@ -11,8 +11,11 @@ .EXAMPLE ```powershell + Set-GitHubVariableSelectedRepository -Owner 'octocat' -Name 'MY_VARIABLE' -RepositoryID 12345678, 87654321 -Context (Get-GitHubContext) ``` + This command sets the repositories with IDs 12345678 and 87654321 to have access to the organization variable 'MY_VARIABLE' in the organization owned by 'octocat'. + .LINK https://psmodule.io/GitHub/Functions/Variables/SelectedRepository/Set-GitHubVariableSelectedRepository From 223c613706c89df2701e5ba1362111687c6fc279 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Sun, 12 Oct 2025 22:13:22 +0200 Subject: [PATCH 15/16] Remove 'Flaky' tag from SelectedRepository context in Variables.Tests.ps1 --- tests/Variables.Tests.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/Variables.Tests.ps1 b/tests/Variables.Tests.ps1 index 0599ac435..7aa9077d7 100644 --- a/tests/Variables.Tests.ps1 +++ b/tests/Variables.Tests.ps1 @@ -277,7 +277,7 @@ Describe 'Variables' { } } - Context 'SelectedRepository' -Tag 'Flaky' { + Context 'SelectedRepository' { It 'Get-GitHubVariableSelectedRepository - gets a list of selected repositories' { LogGroup "SelectedRepositories - [$orgVariableName]" { $result = Get-GitHubVariableSelectedRepository -Owner $owner -Name $orgVariableName From cd916dad937c7ebe3ce6b97b73d57af90bd54318 Mon Sep 17 00:00:00 2001 From: Marius Storhaug Date: Mon, 13 Oct 2025 21:37:11 +0200 Subject: [PATCH 16/16] Add 'Flaky' tag to SelectedRepository context in Variables.Tests.ps1 --- tests/Variables.Tests.ps1 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/Variables.Tests.ps1 b/tests/Variables.Tests.ps1 index 7aa9077d7..0599ac435 100644 --- a/tests/Variables.Tests.ps1 +++ b/tests/Variables.Tests.ps1 @@ -277,7 +277,7 @@ Describe 'Variables' { } } - Context 'SelectedRepository' { + Context 'SelectedRepository' -Tag 'Flaky' { It 'Get-GitHubVariableSelectedRepository - gets a list of selected repositories' { LogGroup "SelectedRepositories - [$orgVariableName]" { $result = Get-GitHubVariableSelectedRepository -Owner $owner -Name $orgVariableName