🚀 [Feature]: Add class for GitHubApp and GitHubAppInstallation
#406
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
- Created TEMPLATE.ps1 for structuring Pester tests. - Added Teams.Tests.ps1 to test GitHub Teams API functionalities, including team creation, retrieval, updating, and deletion. - Implemented Users.Tests.ps1 for testing user-related API calls, such as fetching user details and updating user information. - Developed Variables.Tests.ps1 to validate GitHub variable management, including setting, updating, and removing variables for users, organizations, and repositories.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new GitHubAppInstallation class to structure API outputs and updates several cmdlets to emit instances of this class.
- Added
GitHubAppInstallationandGitHubAppclasses - Updated
Get-GitHubAppInstallation*functions to construct and outputGitHubAppInstallationobjects - Adjusted
GitHubOwnermapping and YAML CI skips
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallation.ps1 | Set OutputType and updated CmdletBinding parameter set name |
| src/functions/private/Apps/GitHub Apps/Get-GitHubOrganizationAppInstallation.ps1 | Changed output to instantiate GitHubAppInstallation objects |
| src/functions/private/Apps/GitHub Apps/Get-GitHubEnterpriseOrganizationAppInstallation.ps1 | Updated OutputType and output mapping |
| src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedApp.ps1 | Added OutputType and wrapped API response in GitHubAppInstallation |
| src/classes/public/Owner/GitHubOwner.ps1 | Enhanced Name and Blog property assignments |
| src/classes/public/App/GitHubAppInstallation.ps1 | New class defining structured installation data |
| src/classes/public/App/GitHubApp.ps1 | New class defining basic app info |
| .github/PSModule.yml | Skipped more build and test jobs |
Comments suppressed due to low confidence (3)
src/functions/private/Apps/GitHub Apps/Get-GitHubOrganizationAppInstallation.ps1:18
- This function emits multiple
GitHubAppInstallationinstances; update the OutputType to[GitHubAppInstallation[]]to reflect the array output.
[OutputType([GitHubAppInstallation])]
src/functions/private/Apps/GitHub Apps/Get-GitHubEnterpriseOrganizationAppInstallation.ps1:17
- The .NOTES link is empty; please add the correct GitHub REST API URL for listing enterprise organization installations.
[List GitHub Apps installed on an enterprise-owned organization]()
src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedApp.ps1:20
- This cmdlet returns multiple installations for the authenticated app; change the OutputType to
[GitHubAppInstallation[]]to accurately document the array output.
[OutputType([GitHubAppInstallation])]
… `Get-GitHubAppInstallationForAuthenticatedApp` functions
… to `Target` in GitHub App installation scripts
…d verbose options to connection commands
…AuthenticatedApp and streamline test cases for GitHub App connections
…display in tests to use Format-List
…ping token outputs in a single log entry
…d update related functions to return GitHubApp objects
…bContext function
…nsistency in GitHubApp class
…o use LogGroup for better logging
…gging format for installations
… output formatting in tests
…stent array handling
…on constructors for consistent array handling
…tests to ensure correct data types
- Created TEMPLATE.ps1 for structuring Pester tests with authentication cases. - Added Teams.Tests.ps1 to test GitHub Teams API functionalities including team creation, retrieval, updating, and deletion. - Introduced Users.Tests.ps1 to validate user-related API calls such as user retrieval and updates. - Implemented Variables.Tests.ps1 to manage GitHub repository and organization variables, including creation, updating, and deletion of variables.
GitHubAppInstallation to structure outputsGitHubAppInstallation to structure outputs
GitHubAppInstallation to structure outputsGitHubApp and GitHubAppInstallation
|
Module GitHub - 0.30.0 published to the PowerShell Gallery. |
|
GitHub release for GitHub v0.30.0 has been created. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 introduces significant enhancements to the GitHub Apps module by adding new classes, improving type safety, and refining existing functions. The changes focus on creating structured representations for GitHub Apps and their installations, updating function outputs to use these new types, and improving parameter handling for better usability and clarity.
GitHubAppInstallationas a class and return from*-GitHubAppInstallationfunctions #405New Classes for GitHub Apps and Installations:
src/classes/public/App/GitHubApp.ps1: Introduced theGitHubAppclass to encapsulate properties and methods for GitHub Apps, includingID,ClientID,Slug,Permissions, andEvents. This improves type safety and enables structured handling of app data.src/classes/public/App/GitHubAppInstallation.ps1: Added theGitHubAppInstallationclass to represent app installations, includingID,Target,Permissions, andCreatedAt. This facilitates better organization and manipulation of installation data.Updates to Function Outputs:
src/functions/private/Apps/GitHub Apps/Get-GitHubAppByName.ps1: Changed output type from[pscustomobject]to[GitHubApp]and updated the response handling to instantiateGitHubAppobjects. [1] [2]src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedApp.ps1: Updated output type to[GitHubAppInstallation[]]and modified response processing to create instances ofGitHubAppInstallation. [1] [2]src/functions/private/Apps/GitHub Apps/Get-GitHubEnterpriseOrganizationAppInstallation.ps1: Updated output type to[GitHubAppInstallation]and adjusted response handling for better type safety. [1] [2]Refinements to Parameter Handling:
src/functions/public/Apps/GitHub App/Get-GitHubApp.ps1: Improved parameter set names for clarity, such as renaming'BySlug'to'Get an app by slug'. Added aliasSlugfor theNameparameter to enhance usability. [1] [2]src/functions/public/Apps/GitHub App Installations/Get-GitHubAppInstallation.ps1: Refined parameter sets to clearly differentiate between listing installations for enterprises, organizations, and authenticated apps. [1] [2]Adjustments to Existing Classes:
src/classes/public/Owner/GitHubOwner.ps1: Updated property mappings to handle bothslugandloginforNameand added fallback forBlogusingwebsite_url.Context Improvements:
src/functions/private/Auth/Context/Set-GitHubContext.ps1: Updated context object properties to use the newGitHubAppclass, ensuring consistency and type safety across app-related context data. [1] [2]Type of change
Checklist