Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CHANGELOG for 1.0.0-beta1 release #521

Merged
merged 9 commits into from
Jan 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 122 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,130 @@
# posh-git Release History

## 1.0.0 - TBD
This release introduces breaking changes with 0.x to both drop support for PowerShell 2.0 and support writing prompt strings using ANSI sequences.
The ANSI sequence support will help with cross-platform PowerShell support, which is another goal of this release.
## 1.0.0-beta1 - January 10, 2018

The 1.0.0 release is targeted specifically at Windows PowerShell 5.x and (cross-platform) PowerShell Core 6.x, both of
which support writing prompt strings using [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_escape_code).
On Windows, support for [Console Virtual Terminal Sequences](https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences)
was added in Windows 10 version 1511.
Consequently this release introduces BREAKING changes with 0.7.x by:

- Dropping support for Windows PowerShell versions 2.0, 3.0 and 4.0.
- Changing the $GitPromptSettings hashtable to a more structured and stongly typed object.
Here is one example of the changed settings structure:
```powershell
$GitPromptSettings.LocalWorkingStatusSymbol = '#'
$GitPromptSettings.LocalWorkingStatusForegroundColor = [ConsoleColor]::DarkRed
```
Changes to:
```powershell
$GitPromptSettings.LocalWorkingStatusSymbol.Text = '#'
$GitPromptSettings.LocalWorkingStatusSymbol.ForegroundColor = [ConsoleColor]::DarkRed
```
- Changing `Write-VcsStatus`, `Write-GitStatus` and `Write-Prompt` to return a string rather than write to host when
the host supports ANSI escape sequences.

If you are still on Windows PowerShell 2.0, 3.0 or 4.0, please continue to use the 0.7.x version of posh-git.

### Removed

- Drop support for PowerShell 2.0
  ([#163](https://github.com/dahlbyk/posh-git/issues/163))
 ([PR #427](https://github.com/dahlbyk/posh-git/pull/427))
- Remove public `Enable-GitColors`, `Get-AliasPattern` and `Get-GitBranch`; plus `Invoke-NullCoalescing` and its `??` alias
([#163](https://github.com/dahlbyk/posh-git/issues/163))
([PR #427](https://github.com/dahlbyk/posh-git/pull/427))
- Drop support for PowerShell 3.0 and 4.0
([#328](https://github.com/dahlbyk/posh-git/issues/328))
([PR #513](https://github.com/dahlbyk/posh-git/pull/513))
- Remove public `Enable-GitColors`, `Get-AliasPattern`, `Get-GitBranch` and `Invoke-NullCoalescing` and its `??` alias
([#93](https://github.com/dahlbyk/posh-git/issues/93))
 ([PR #427](https://github.com/dahlbyk/posh-git/pull/427))
([PR #427](https://github.com/dahlbyk/posh-git/pull/427))

### Added

- Implement support for ANSI escape sequences for colored output - support System.ConsoleColor, System.Drawing.HtmlColor
(if available on the platform) and 24-bit color. NOTE: this is a breaking change since `Write-VcsStatus`,
`Write-GitStatus` and `Write-Prompt` will now return a string rather than write to the host when the host supports
ANSI escape sequences.
([#304](https://github.com/dahlbyk/posh-git/pull/304))
([#447](https://github.com/dahlbyk/posh-git/pull/447))
([#455](https://github.com/dahlbyk/posh-git/pull/455))
- $GitPromptSettings is now a strongly typed object using PS classes
([#344](https://github.com/dahlbyk/posh-git/issues/344))
([PR #513](https://github.com/dahlbyk/posh-git/pull/513))
- Provide more granular commands than just `Write-GitStatus`.
([#345](https://github.com/dahlbyk/posh-git/issues/345))
([PR #513](https://github.com/dahlbyk/posh-git/pull/513))
We now export the commands that `Write-GitStatus` uses internally which are:
* Write-GitBranchName
* Write-GitBranchStatus
* Write-GitIndexStatus
* Write-GitStashCount
* Write-GitWorkingDirStatus
* Write-GitWorkingDirStatusSummary

### Fixed

- Fixed Get-AuthenticodeSignature not on PS Core.
([PR #487](https://github.com/dahlbyk/posh-git/pull/487))
- Provide DefaultPromptPrefixColor and DefaultPromptSuffixColor options
([#474](https://github.com/dahlbyk/posh-git/issues/474))
([PR #520](https://github.com/dahlbyk/posh-git/pull/520))
- Fixed posh-git prompt makes PowerShell transcripts less readable
([#282](https://github.com/dahlbyk/posh-git/issues/282))
([PR #447](https://github.com/dahlbyk/posh-git/pull/447))

## 0.7.2 - January 10, 2018

- posh-git now exports the variable `$GitPromptScriptBlock` which contains the code for the default prompt.
([#501](https://github.com/dahlbyk/posh-git/issues/501))
([PR #513](https://github.com/dahlbyk/posh-git/pull/513))

If you need to execute your own logic in your own prompt function but still want to display the default posh-git
prompt, you can execute this scriptblock from your prompt function e.g.:

```powershell
# profile.ps1
function prompt {
Set-NodeVersion
&$GitPromptScriptBlock
}
Import-Module posh-git
```

- Added `Add-PoshGitToProfile -AllUsers` support
([PR #504](https://github.com/dahlbyk/posh-git/pull/504))
- Fixed 'Write-Prompt' to be able use Black as foreground color.
([#470](https://github.com/dahlbyk/posh-git/pull/470))
([PR #468](https://github.com/dahlbyk/posh-git/pull/468))
Thanks Vladimir Poleh (@vladimir-poleh)
- Pass "git.exe" instead of "git" to Get-Command.
([PR #478](https://github.com/dahlbyk/posh-git/pull/478))
([PR #479](https://github.com/dahlbyk/posh-git/pull/479))
Thanks Mike Sigsworth (@mikesigs)
- Squash ssh agent warnings if `-Quiet`.
([PR #484](https://github.com/dahlbyk/posh-git/pull/484))
Thanks Refael Ackermann (@refack)
- Fixed directory names that contain [brackets] cause GitPrompt to fail.
([PR #502](https://github.com/dahlbyk/posh-git/pull/502))
Thanks Duncan Smart (@duncansmart)
- Fixed duplicated branch completion for git checkout
([#505](https://github.com/dahlbyk/posh-git/issues/505))
([PR #506](https://github.com/dahlbyk/posh-git/pull/506))
([PR #512](https://github.com/dahlbyk/posh-git/pull/512))
Thanks Christoph Bergmeister (@bergmeister)
- Fixed PSScriptAnalyzer warnings in the source
([PR #509](https://github.com/dahlbyk/posh-git/pull/509))
Thanks Christoph Bergmeister (@bergmeister)
- Fixed errors added to $Error collection by `Get-GitStatus` command
([#500](https://github.com/dahlbyk/posh-git/issues/500))
([PR #514](https://github.com/dahlbyk/posh-git/pull/514))
- Add custom path rendering in prompt
([#469](https://github.com/dahlbyk/posh-git/issues/469))
([PR #520](https://github.com/dahlbyk/posh-git/pull/520))
- Clean up wording for work dir local status in help file
([PR #516](https://github.com/dahlbyk/posh-git/pull/516))
- Add code coverage to Coveralls.io
([#416](https://github.com/dahlbyk/posh-git/pull/416))
([PR #461](https://github.com/dahlbyk/posh-git/pull/461))
Thanks Jan De Dobbeleer (@JanJoris)

## 0.7.1 - March 14, 2017

Expand Down
2 changes: 1 addition & 1 deletion chocolatey/poshgit.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<metadata>
<id>poshgit</id>
<title>posh-git</title>
<version>1.0.0-pre00</version>
<version>1.0.0-beta1</version>
<authors>Keith Dahlby, Mark Embling, Jeremy Skinner, Keith Hill</authors>
<owners>Keith Dahlby</owners>
<description>### posh-git
Expand Down
2 changes: 1 addition & 1 deletion src/posh-git.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ PrivateData = @{
ReleaseNotes = 'https://github.com/dahlbyk/posh-git/blob/develop/CHANGELOG.md'

# OVERRIDE THIS FIELD FOR PUBLISHED RELEASES - LEAVE AT 'alpha' FOR CLONED/LOCAL REPO USAGE
Prerelease = 'alpha'
Prerelease = 'beta1x'
}
}

Expand Down