Skip to content

CHANGELOG.md

Latest commit

 

History

History
391 lines (312 loc) · 23.5 KB

CHANGELOG.md

File metadata and controls

391 lines (312 loc) · 23.5 KB

PowerShellForGitHub PowerShell Module

Changelog

0.14.0 - (2020/05/30)

Features:

  • The module will now asynchronously check for updates up to once per day. This can be disabled if desired with the Set-GitHubConfiguration -DisableUpdateCheck. [pr] | [cl]
  • It turns out that Group-GitHubPullRequest which was written back in 0.2.0 was never actually exported. Now it is. [pr] | [cl]

Fixes:

  • Fixes the behavior of Get-GitHubRepository. It actually had a number of issues: [pr] | [cl]
    • -GetAllPublicRepositories didn't acutally work. Now it does, along with the newly added Since parameters.
    • Fixed the ParameterSet handling for all parameters to make sure that users can only specify the correct combination of parameters.
  • Fixes multi-result behavior across all versions of PowerShell. You can now reliably capture the result of an API call like this: @(Get-GitHubRepository ...) and be assured that you'll get an array result with the proper count of items. As a result, this fixes all remaining failing UT's on PowerShell 7. [pr] | [cl]
  • Fixed an erroneous exception that occurred when calling New-GitHubRepository when specifying a TeamId. [pr] | [cl]
  • The module is now PSScriptAnalyzer clean (again). This also fixed pipeline handling in Group-GitHubPullRequest, Group-GitHubIssue and ConvertFrom-GitHubMarkdown. [pr] | [cl]
  • Fixed some documentation which referenced that private repos were only available to paid GitHub plans. [pr] | [cl]
  • Fixed a bug preventing quering for a specifically named branch with Get-GitHubRepositoryBranch. [pr] | [cl]
  • Correctly fixed the hash that catches whether or not a developer has updated the settings file used when running this module's unit tests. It involved updating the hash and then also ensuring we always check the file out with consistent line endings. [pr] | [cl] && [pr] | [cl]
  • Documentation updates around configuring unattended authentication. [pr] | [cl]

Authors:

0.13.1 - (2020/05/12)

Fixes:

  • Ensure progress bar for Wait-JobWithAnimation gets marked as Completed [pr] | [cl]

Authors:

0.13.0 - (2020/05/12)

Improvement:

  • Migrate REST API progress status to use Write-Progress [pr] | [cl]

Authors:

0.12.0 - (2020/05/12)

Features:

  • Added core support for Projects [pr] | [cl]
  • Added suport for Project Columns [pr] | [cl]
  • Added suport for Project Cards [pr] | [cl]
  • Added sample usage documentation for the new Project API's [pr] | [cl]

Fixes:

  • Minor spelling fixes in documentation throughout module [pr] | [cl]
  • Fixed confirmation message for Rename-GitHubRepository [pr] | [cl]

Authors:

0.11.0 - (2020/04/03)

Features:

Author: @Shazwazza

0.10.0 - (2020/03/02)

Features:

  • Added Rename-GitHubRepository [pr] | [cl]

Author: @mtboren

0.9.2 - (2019/11/11)

Fixes:

  • Reduces the warning noise seen during execution of the unit tests. [pr] | [cl]

Author: @smaglio81

0.9.1 - (2019/09/24)

Fixes:

  • Ensure Milestone due_on always gets set to the desired date. (Attempts to work around odd GitHub behavior which uses PST/PDT's midnight to determine the date instead of UTC.) [pr] | [cl]
  • Fix Update-GitHubRepository to work correctly
    • The REST endpoint had a typo in it [pr] | [cl]
    • The Archived switch's value was being incorrectly inverted [pr] | [cl]

Author: @HowardWolosky

0.9.0 - (2019/09/19)

Features:

Fixes:

  • Updates the GitHub Enterprise support to use the http(s)://[hostname]/api/v3 syntax instead of the non-standard http(s)://api.[hostname]/ syntax. [pr] | [cl]
  • Minor Comment Based Help (CBH) update for Get-GitHubRepository [pr] | [cl]

Authors:

0.8.0 - (2019/04/12)

Features:

  • Added support for GitHub Enterprise users by adding a new ApiHostName configuration value. (more info) [pr] | [cl]

Fixes:

  • Renamed ConvertFrom-Markdown to ConvertFrom-GitHubMarkdown to avoid a conflict with PSCore's new ConvertFrom-Markdown command. [pr] | [cl]

Authors:

0.7.0 - (2019/03/15)

Features:

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

Fixes:

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

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. [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. [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. {[pr] | [cl] and [pr] | [cl]}

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. [pr] | [cl]

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. [pr] | [cl]

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) [pr] | [cl]

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. [pr] | [cl]
  • Prevented the possibility of Access Tokens from being written into the log file in plain text if explicitly passed-in [pr] | [cl]

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