Skip to content

Commit

Permalink
Changelog and upgrade guide changes
Browse files Browse the repository at this point in the history
  • Loading branch information
hazmat345 committed Nov 10, 2020
1 parent a85d0c4 commit 81bd121
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 5 deletions.
22 changes: 19 additions & 3 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,34 @@ Brewtils Changelog

3.0.0
-----
Date: TBD
Date: 11/10/20

Note: This is a major upgrade with several breaking changes. Please see the
`Upgrade Guide
<https://github.com/beer-garden/brewtils/blob/master/UPGRADING.md>`_ for all changes.

See the Upgrade Guide for upgrading from v2 to v3.

New Features
^^^^^^^^^^^^
- Plugins now automatically load configuration from CLI and environment variables
- Logging configuration is loaded automatically when Plugins are created
- No longer need to pass connection information to System/Easy/Rest Clients
- Parameter choices definition can be a non-list iterable (beer-garden/#512)
- It's now easier to specify an alternate parent when making a request (beer-garden/#336)
- SchemaParser can now directly serialize dicts and Boxes (#239)

Bug Fixes
^^^^^^^^^
- EasyClient.get_instance_status is deprecated but now actually returns the instance status

- Parameter choices definition can be a non-list iterable (beer-garden/#512)
Other Changes
^^^^^^^^^^^^^
- Plugins are now multi-threaded by default (#47)
- Better error messages when using SystemClient with raise_on_error=True (beer-garden/#689)
- Various deprecated names have been removed
- Can now defer setting a Plugin client
- EasyClient.get_version returns actual version information instead of Response object
- Using a pika version <1 is deprecated

2.4.14
------
Expand Down
2 changes: 0 additions & 2 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,8 +262,6 @@ The `Plugin.run()` method now raises a `brewtils.errors.RestConnectionError` if
### `SystemClient`

#### Alternate Parent
TODO - This is really a new feature, may not need to be in the Upgrade Guide.

It's now easier to specify an alternate parent Request when using the `SystemClient`:

```python
Expand Down

0 comments on commit 81bd121

Please sign in to comment.