Module restructure to v0.2.0#39
Merged
Merged
Conversation
+ Significant restructing and refactoring of entire module to make future expansion easier. + Significant documentation updates ([CHANGELOG](./CHANGELOG.md), [CONTRIBUTING.md](./CONTRIBUTING.md), [GOVERNANCE.md](./GOVERNANCE.md), [README.md](./README.md), [USAGE.md](./USAGE.md)) + Added `Set-GitHubAuthentication` (and related methods) for securely caching the Access Token + Added `Set-GitHubConfiguration` (and related methods) to enable short and long-term configuration of the module. + Added ability to asynchronously see status update of REST requests. + Added logging and telemetry to the module (each can be disabled if desired). + Tests now auto-configure themselves across whatever account information is supplied in [Tests/Config/Settings.ps1](./Tests/Config/Settings.ps1) + Added support for a number of additional GitHub API's: + All [Miscellaneous API's](https://developer.github.com/v3/misc/) + Ability to fully query, update, remove, lock, and unlock Issues. + Enhanced pull request querying support + Ability tofully query, create, and remove Repositories, as well as transfer ownership, get tags, get/set topic and current used programming languages. + Enhanced user query support as well as being able update information for the current user. * Made parameter ordering consistent across all functions (OwnerName is now first, then RepositoryName) * Normalized all parameters to use SentenceCase * All functions that can take a Uri or OwnerName/RepositoryName now support both options. * Made all parameter names consistent across functions: * `GitHubAccessToken` -> `AccessToken` * `RepositoryUrl` -> `Uri` * `Organization` -> `OrganizationName` * `Repository` -> `RepositoryName` * `Owner` -> `OwnerName` * Normalized usage of Verbose, Info and Error streams - `New-GitHubLabels` was renamed to `Set-GitHubLabel` and can now optionally take in the labels to apply to the Repository. - `Get-GitHubIssueForRepository` has been removed and replaced with `Get-GitHubIssue`. The key difference between these two is that it no longer accepts multiple repositories as single input, and filtering on creation/closed date can be done after the fact piping the results into `Where-Object` now that the returned objects from `Get-GitHubIssue` have actual `[DateTime]` values for the date properties. For an updated example of doing this, refer to [example usage](USAGE.md#querying-issues). - `Get-GitHubWeeklyIssueForRepository` has been removed and functionally replaced by `Group-GitHubIssue`. For an updated example of using it, refer to [example usage](USAGE.md#querying-issues) - `Get-GitHubTopIssueRepository` has been removed. We have [updated examples](USAGE.md#querying-issues) for how to accomplish the same scenario. - `Get-GitHubPullRequestForRepository` has been removed and replaced with `Get-GitHubPullRequest`. The key difference between these two is that it no longer accepts multiple repositories as single input, and filtering on creation/merged date can be done after the fact piping the results into `Where-Object` now that the returned objects from `Get-GitHubPullRequest` have actual `[DateTime]` values for the date properties. For an updated example of doing this, refer to [example usage](USAGE.md#querying-pull-requests). - `Get-GitHubWeeklyPullRequestForRepository` has been removed and functionally replaced by `Group-GitHubPullRequest`. For an updated example of using it, refer to [example usage](USAGE.md#querying-pull-requests) - `Get-GitHubTopPullRequestRepository` has been removed. We have [updated examples](USAGE.md#querying-pull-requests) for how to accomplish the same scenario. - `Get-GitHubRepositoryNameFromUrl` and `GitHubRepositoryOwnerFromUrl` have been removed and functionally replaced by `Split-GitHubUri` - `Get-GitHubRepositoryUniqueContributor` has been removed. We have an [updated example](USAGE.md#querying-contributors) for how to accomplish the same scenario. - `GitHubOrganizationRepository` has been removed. You can now retrieve repositories for an organization via `Get-GitHubRepository -OrganizationName <name>`. - `Get-GitHubAuthenticatedUser` has been replaced with `Get-GitHubUser -Current`. Fixes Issue microsoft#34: Warning output on import is being written out twice Fixes Issue microsoft#33: TLS error in Get-GitHubIssueForRepository : Failed to execute query with exception Fixes Issue microsoft#26: Token in template file Fixes Issue microsoft#24: Add a command for configuration
Contributor
Author
|
The CI failed because it's still working with the old credentials. Once this change comes in, it will work against the new credentials. |
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
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.
Features:
GOVERNANCE.md, README.md, USAGE.md)
Set-GitHubAuthentication(and related methods) for securely caching the Access TokenSet-GitHubConfiguration(and related methods) to enable short and long-term configurationof the module.
Tests/Config/Settings.ps1
get tags, get/set topic and current used programming languages.
Fixes:
GitHubAccessToken->AccessTokenRepositoryUrl->UriOrganization->OrganizationNameRepository->RepositoryNameOwner->OwnerNameFunctionality Modified from 0.1.0:
New-GitHubLabelswas renamed toSet-GitHubLabeland can now optionally take in the labelsto apply to the Repository.
Get-GitHubIssueForRepositoryhas been removed and replaced withGet-GitHubIssue.The key difference between these two is that it no longer accepts multiple repositories as single
input, and filtering on creation/closed date can be done after the fact piping the results into
Where-Objectnow that the returned objects fromGet-GitHubIssuehave actual[DateTime]valuesfor the date properties. For an updated example of doing this, refer to example usage.
Get-GitHubWeeklyIssueForRepositoryhas been removed and functionally replaced byGroup-GitHubIssue.For an updated example of using it, refer to example usage
Get-GitHubTopIssueRepositoryhas been removed. We have updated examplesfor how to accomplish the same scenario.
Get-GitHubPullRequestForRepositoryhas been removed and replaced withGet-GitHubPullRequest.The key difference between these two is that it no longer accepts multiple repositories as single
input, and filtering on creation/merged date can be done after the fact piping the results into
Where-Objectnow that the returned objects fromGet-GitHubPullRequesthave actual[DateTime]valuesfor the date properties. For an updated example of doing this, refer to example usage.
Get-GitHubWeeklyPullRequestForRepositoryhas been removed and functionally replaced byGroup-GitHubPullRequest.For an updated example of using it, refer to example usage
Get-GitHubTopPullRequestRepositoryhas been removed. We have updated examplesfor how to accomplish the same scenario.
Get-GitHubRepositoryNameFromUrlandGitHubRepositoryOwnerFromUrlhave been removed andfunctionally replaced by
Split-GitHubUriGet-GitHubRepositoryUniqueContributorhas been removed. We have anupdated example for how to accomplish the same scenario.
GitHubOrganizationRepositoryhas been removed. You can now retrieve repositories for anorganization via
Get-GitHubRepository -OrganizationName <name>.Get-GitHubAuthenticatedUserhas been replaced withGet-GitHubUser -Current.Fixes Issue #34: Warning output on import is being written out twice
Fixes Issue #33: TLS error in Get-GitHubIssueForRepository : Failed to execute query with exception
Fixes Issue #26: Token in template file
Fixes Issue #24: Add a command for configuration