Skip to content

Latest commit

 

History

History
265 lines (196 loc) · 13.9 KB

CHANGELOG.md

File metadata and controls

265 lines (196 loc) · 13.9 KB
Raw

PowerShellForGitHub PowerShell Module

Changelog

0.8.0 - (2019/04/12)

Features:

  • Added support for GitHub Enterprise users by adding a new ApiHostName configuration value. (more info)

Fixes:

  • Renamed ConvertFrom-Markdown to ConvertFrom-GitHubMarkdown to avoid a conflict with PSCore's new ConvertFrom-Markdown command.

More Info:

Authors:

0.7.0 - (2019/03/15)

Fixes:

  • Modified all [int] parameters to be [int64] to avoid out of bounds issues with large ID's.
  • Split-GitHubUri updated to work with the https://api.github.com/* uri's included in some of the REST responses.

Features:

  • Added Test-GitHubOrganizationMember to test if a user is in an organization.
  • Updated Get-GitHubTeamMember to optionally work directly with a TeamId.

More Info:

Author: @HowardWolosky

0.6.4 - (2019/01/16)

Fixes:

  • Updated the *-GitHubIssue functions to support specifying the MediaType that should be used for the returned result.

More Info: [pr] | [cl]

Author: @joseartrivera

0.6.3 - (2019/01/07)

Fixes:

  • Updated all parameter sets to use CamelCase for the permitted options, and stopped any use of abbreviation, to be more consistent with the rest of PowerShell.

More Info: [pr] | [cl]

Author: @HowardWolosky

0.6.2 - (2018/12/13)

Fixes:

  • Fixes a bug preventing Labels from being correctly added at the time of new Issue creation or modified when updating an issue.

More Info:

Authors:

0.6.1 - (2018/12/13)

Fixes:

  • Fixes a bug with checking Issues. When trying to list all issues, it tried to speficially look for Issue 0.

More Info:

Authors:

0.6.0 - (2018/12/13)

Features:

  • Completes all support for GitHub Issue API's:
  • Added new LogRequestBody configuration option to help with development, allowing you to see the exact body of the REST request being sent before it is sent over the wire.

More Info:

Authors:

0.5.0 - (2018/11/30)

Features:

Fixes:

  • Fixed bug that caused single or empty arrays returned within objects to be flattened (instead of remaining as arrays)

More Info:

Authors:

0.4.0 - (2018/11/16)

Features:

Fixes:

  • Made NuGet dll retrieval more robust by preventing potential file access problems from being written to the error stream.
  • Prevented the possibility of Access Tokens from being written into the log file in plain text if explicitly passed-in

More Info:

Authors:

0.3.1 - (2018/11/13)

Fixes:

  • Minor static analysis issues fixed.
  • Corrected name of the test file for GitHubRepositoryForks
  • Ensured the getParams are used during execution of Get-GitHubRepositoryFork

More Info: [pr] | [cl]

Author: @HowardWolosky

0.3.0 - (2018/11/13)

Features:

  • Added support for querying forks and creating new ones.

Fixes:

  • Will only perform a retry when receiving a 202 response on a GET request. Previously, it would retry regardless of the method of the request.

More Info: [pr] | [cl]

Author: @HowardWolosky

0.2.0 - (2018/11/13)

Features:

  • Significant restructing and refactoring of entire module to make future expansion easier.
  • Significant documentation updates (CHANGELOG, CONTRIBUTING.md, GOVERNANCE.md, README.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
  • Added support for a number of additional GitHub API's:
    • All Miscellaneous API's
    • 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.

Fixes:

  • 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

Functionality Modified from 0.1.0:

  • 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.
  • Get-GitHubWeeklyIssueForRepository has been removed and functionally replaced by Group-GitHubIssue. For an updated example of using it, refer to example usage
  • Get-GitHubTopIssueRepository has been removed. We have updated examples 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.
  • Get-GitHubWeeklyPullRequestForRepository has been removed and functionally replaced by Group-GitHubPullRequest. For an updated example of using it, refer to example usage
  • Get-GitHubTopPullRequestRepository has been removed. We have updated examples 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 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.

More Info: [pr] | [cl]

Author: @HowardWolosky

0.1.0 - (2016/11/29)

Features:

  • Initial public release

More Info: [cl]

Author: @KarolKaczmarek