🩹[Patch]: Add .LINK documentation to various GitHub functions #394
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…k configuration link - Added .LINK section to multiple PowerShell scripts in the Repositories, Status, Users, Variables, and Webhooks directories for better documentation access. - Updated the link for Get-GitHubAppWebhookConfiguration to point to the correct path.
There was a problem hiding this comment.
Pull Request Overview
This pull request adds .LINK metadata to various PowerShell function documentation blocks to provide direct online documentation links.
- Added .LINK metadata for authentication, apps, artifacts, and actions functions.
- Corrected the documentation URL for Remove-GitHubArtifact to point to the proper location.
Reviewed Changes
Copilot reviewed 107 out of 107 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/functions/public/Auth/Disconnect-GitHubAccount.ps1 | Added .LINK metadata with the correct URL for Disconnect-GitHubAccount. |
| src/functions/public/Auth/Context/Switch-GitHubContext.ps1 | Added .LINK metadata for Switch-GitHubContext. |
| src/functions/public/Auth/Context/Get-GitHubContext.ps1 | Added .LINK metadata for Get-GitHubContext. |
| src/functions/public/Auth/Connect-GitHubApp.ps1 | Added .LINK metadata for Connect-GitHubApp. |
| src/functions/public/Auth/Connect-GitHubAccount.ps1 | Added .LINK metadata for Connect-GitHubAccount. |
| src/functions/public/Artifacts/Remove-GitHubArtifact.ps1 | Updated .LINK metadata URL to correctly reference the Artifacts documentation. |
| src/functions/public/Apps/GitHub App/Uninstall-GitHubApp.ps1 | Added .LINK metadata for Uninstall-GitHubApp. |
| src/functions/public/Apps/GitHub App/New-GitHubAppInstallationAccessToken.ps1 | Added .LINK metadata for New-GitHubAppInstallationAccessToken. |
| src/functions/public/Apps/GitHub App/Install-GitHubApp.ps1 | Added .LINK metadata for Install-GitHubApp. |
| src/functions/public/Apps/GitHub App/Get-GitHubAppJSONWebToken.ps1 | Added .LINK metadata for Get-GitHubAppJSONWebToken. |
| src/functions/public/Apps/GitHub App/Get-GitHubAppInstallableOrganization.ps1 | Added .LINK metadata for Get-GitHubAppInstallableOrganization. |
| src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1 | Added .LINK metadata for Get-GitHubApp. |
| src/functions/public/Apps/GitHub App Installations/Update-GitHubAppInstallationRepositoryAccess.ps1 | Added .LINK metadata for Update-GitHubAppInstallationRepositoryAccess. |
| src/functions/public/Apps/GitHub App Installations/Remove-GitHubAppInstallationRepositoryAccess.ps1 | Added .LINK metadata for Remove-GitHubAppInstallationRepositoryAccess. |
| src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallationRepositoryAccess.ps1 | Added .LINK metadata for Get-GitHubAppInstallationRepositoryAccess. |
| src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallation.ps1 | Added .LINK metadata for Get-GitHubAppInstallation. |
| src/functions/public/Apps/GitHub App Installations/Get-GitHubAppAccessibleRepository.ps1 | Added .LINK metadata for Get-GitHubAppAccessibleRepository. |
| src/functions/public/Apps/GitHub App Installations/Add-GitHubAppInstallationRepositoryAccess.ps1 | Added .LINK metadata for Add-GitHubAppInstallationRepositoryAccess. |
| src/functions/public/Actions/Data/Get-GitHubRunnerData.ps1 | Added .LINK metadata for Get-GitHubRunnerData. |
| src/functions/public/Actions/Data/Get-GitHubEventData.ps1 | Added .LINK metadata for Get-GitHubEventData. |
This pull request includes minor corrections to spelling errors in several PowerShell scripts. The changes improve code readability and professionalism by fixing typos in comments and verbose output messages. ### Spelling Corrections: * [`src/functions/public/Apps/GitHub App/New-GitHubAppInstallationAccessToken.ps1`](diffhunk://#diff-774c84d27d7d36246f2918664f83ae9c8621d065031859586ade1b209b14849bL49-R49): Corrected "recieved" to "received" in a justification comment for a suppression attribute. * [`src/functions/public/Auth/Connect-GitHubAccount.ps1`](diffhunk://#diff-12918e90451cdedb78571b9a67ac0313331a25175cebb606b7108b7bf06af092L50-R50): Corrected "recieved" to "received" in a justification comment for a suppression attribute. * [`src/functions/public/Auth/Connect-GitHubApp.ps1`](diffhunk://#diff-7d1951ca779d73ee11b11db4ade6f33f8ea5fcf052324a72d2c8e83304eaa045L40-R40): Corrected "recieved" to "received" in a justification comment for a suppression attribute. * [`src/functions/public/Commands/Set-GitHubOutput.ps1`](diffhunk://#diff-e3aad576b04b558ce2a70ebd0dcc703418e81431e3c0f0ed63a3736ae35de2efL89-R91): Corrected "avaiable" to "available" in verbose output messages.
MariusStorhaug
temporarily deployed
to
github-pages
GitHub Actions
Inactive
|
Module GitHub - 0.28.4 published to the PowerShell Gallery. |
|
GitHub release for GitHub v0.28.4 has been created. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request adds
.LINKmetadata to PowerShell function documentation across multiple files, providing direct links to the online documentation for each function. These changes improve the discoverability and usability of the module by enabling users to quickly access detailed documentation.Documentation Enhancements:
.LINKmetadata to multiple functions.Type of change
Checklist