Skip to content

Commit

Permalink
Prepare 1.4.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonFrings committed Sep 2, 2022
1 parent 1dc0040 commit 5861005
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 11 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# Changelog

## 1.4.0 (2022-09-02)

* Feature: Full support for PHP 8.1 and PHP 8.2.
(#32 by @clue and #37 by @SimonFrings)

* Feature: Mark passwords and URIs as `#[\SensitiveParameter]` (PHP 8.2+).
(#38 by @SimonFrings)

* Feature: Forward compatibility with upcoming Promise v3.
(#35 by @clue)

* Feature: Avoid dependency on `ext-filter`.
(#31 by @clue)

* Improve test suite and use new reactphp/async package instead of clue/reactphp-block.
(#36 and #39 by @SimonFrings)

## 1.3.0 (2021-08-06)

* Feature: Simplify usage by supporting new default loop.
Expand Down
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ make sure that you have a suitable SSH client installed. On Debian/Ubuntu-based
systems, you may simply install it like this:

```bash
$ sudo apt install openssh-client
sudo apt install openssh-client
```

Its constructor simply accepts an SSH proxy server URL:
Expand Down Expand Up @@ -190,7 +190,7 @@ have a suitable SSH client installed. On Debian/Ubuntu-based systems, you may
simply install it like this:

```bash
$ sudo apt install openssh-client
sudo apt install openssh-client
```

Its constructor simply accepts an SSH proxy server URL:
Expand Down Expand Up @@ -511,7 +511,7 @@ can access your SSH proxy server on the command line like this:

```bash
# test SSH access
$ ssh [email protected] echo hello
ssh [email protected] echo hello
```

Because this class is designed to be used to create any number of connections,
Expand All @@ -537,7 +537,7 @@ For this to work, you will have to have the `sshpass` binary installed. On
Debian/Ubuntu-based systems, you may simply install it like this:

```bash
$ sudo apt install sshpass
sudo apt install sshpass
```

Note that both the username and password must be percent-encoded if they contain
Expand All @@ -560,7 +560,7 @@ This project follows [SemVer](https://semver.org/).
This will install the latest supported version:

```bash
$ composer require clue/reactphp-ssh-proxy:^1.3
composer require clue/reactphp-ssh-proxy:^1.4
```

See also the [CHANGELOG](CHANGELOG.md) for details about version upgrades.
Expand All @@ -575,15 +575,15 @@ client binary, so you'll have to make sure that you have a suitable SSH client
installed. On Debian/Ubuntu-based systems, you may simply install it like this:

```bash
$ sudo apt install openssh-client
sudo apt install openssh-client
```

Additionally, if you use [password authentication](#password-authentication)
(not recommended), then you will have to have the `sshpass` binary installed. On
Debian/Ubuntu-based systems, you may simply install it like this:

```bash
$ sudo apt install sshpass
sudo apt install sshpass
```

*Running on [Windows is currently not supported](https://github.com/clue/reactphp-ssh-proxy/issues/12)*
Expand All @@ -594,13 +594,13 @@ To run the test suite, you first need to clone this repo and then install all
dependencies [through Composer](https://getcomposer.org/):

```bash
$ composer install
composer install
```

To run the test suite, go to the project root and run:

```bash
$ vendor/bin/phpunit
vendor/bin/phpunit
```

The test suite contains a number of tests that require an actual SSH proxy server.
Expand All @@ -610,8 +610,8 @@ environment and prefix this with a space to make sure your login credentials are
not stored in your bash history like this:

```bash
$ export SSH_PROXY=alice:[email protected]
$ vendor/bin/phpunit
export SSH_PROXY=alice:[email protected]
vendor/bin/phpunit
```

## License
Expand Down

0 comments on commit 5861005

Please sign in to comment.