Skip to content

Commit

Permalink
[skip ci] Prepare 4.0.1 release
Browse files Browse the repository at this point in the history
  • Loading branch information
NelsonVides committed Nov 17, 2020
1 parent b872708 commit 5cb7ef8
Show file tree
Hide file tree
Showing 7 changed files with 61 additions and 14 deletions.
36 changes: 35 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,38 @@
# [MongooseIM 4.0.1](https://github.com/esl/MongooseIM/releases/tag/4.0.1) - 2020-11-17

## Highlights
- A new metric now reports the type of configuration file that is being used. The aim is to determine the adoption of the new config file format.
- Better error messages are reported from wrong TOML configuration files.

## All changes

### Added
- User-friendly errors for the TOML configuration file (#2903)
- Metric to report the type of config file used (#2918)

### Removed
- Removed deprecated `mod_http_notifications` #2912

### Changed
- TOML documentation improvements (#2896, #2898, #2899, #2901, #2905, #2942)
- Some TOML configuration options have been reformatted (#2909)
- More prepared queries to improve RDBMS performance (#2924, #2928)
- Fixed Ubuntu 18.04 and OTP 23.1 for building docker images (#2926)
- Moving from untyped binaries to proper `jid` structures (#2895, #2920, #2922)

### Other
- Dependencies update (#2914)
- REST error handling cleanup (#2908)
- `nksip` is started only when used (#2937)
- RPM package improvements (#2906)
- CI improvements (#2910, #2934)

## Commits, merged PRs and closed issues
- [List of merged PRs](https://github.com/esl/MongooseIM/pulls?q=is%3Apr+is%3Amerged+milestone%3A4.0.1)

[List of merged PRs based on merge date]: # (https://github.com/esl/MongooseIM/pulls?utf8=%E2%9C%93&q=is%3Apr%20base%3Amaster%20merged%3A%222020-09-30..2020-11-13%22%20sort%3Acreated-asc%20)


# [MongooseIM 4.0.0](https://github.com/esl/MongooseIM/releases/tag/4.0.0) - 2020-09-30
## Overview
MongooseIM 4.0 is all about putting a friendly face to MongooseIM’s amazing features.
Expand All @@ -13,7 +48,6 @@ Logging and Kubernetes improvements to be more DevOps-friendly and Manager-frien
* Documentation has been improved
* Structured logging: the main idea of structured logging is that if we have properties of an event, let’s log them as they are, without losing their structure, and format it in a way that is most appropriate for the system we’re sending them to.
* Moved to [OTP logger](https://erlang.org/doc/man/logger.html) from [lager](https://github.com/erlang-lager/lager) (#2810)
* Moved away from [lager](https://github.com/erlang-lager/lager), towards [OTP logger](https://erlang.org/doc/man/logger.html) (#2810)
* No more logging of man-made strings, we now log structured reports (#2816)
* `logfmt` formatter, a log format that's easy to read and write (#2848)
* `JSON` formatter, a fully structured format (#2851)
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Check out our test results:
Up-to-date documentation for the MongooseIM master branch can be found on ReadTheDocs: [https://mongooseim.readthedocs.io/en/latest/](https://mongooseim.readthedocs.io/en/latest/).

Latest releases:
* [4.0.0](https://mongooseim.readthedocs.io/en/4.0.0/)
* [4.0.1](https://mongooseim.readthedocs.io/en/4.0.1/)
* [3.7.1](https://mongooseim.readthedocs.io/en/3.7.1/)
* [3.6.2](https://mongooseim.readthedocs.io/en/3.6.2/)
* [3.5.0](https://mongooseim.readthedocs.io/en/3.5.0/)
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
4.0.0
4.0.1
2 changes: 1 addition & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Check out our test results:
See the documentation for the latest releases:

* [Master](https://mongooseim.readthedocs.org/en/latest/)
* [4.0.0](https://mongooseim.readthedocs.io/en/4.0.0/)
* [4.0.1](https://mongooseim.readthedocs.io/en/4.0.1/)
* [3.7.1](https://mongooseim.readthedocs.io/en/3.7.1/)
* [3.6.2](https://mongooseim.readthedocs.io/en/3.6.2/)
* [3.5.0](https://mongooseim.readthedocs.io/en/3.5.0/)
Expand Down
2 changes: 2 additions & 0 deletions doc/migrations/3.7.0_4.0.0.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## TOML configuration file

> Note that a minor [4.0.1](https://github.com/esl/MongooseIM/releases/tag/4.0.1) version has been released with small but important changes to take into account if you're migrating to MongooseIM 4.0.
There is a new [TOML configuration file](../../Advanced-configuration): `mongooseim.toml`.
The legacy `mongooseim.cfg` file is still supported as an alternative, but deprecated.

Expand Down
21 changes: 21 additions & 0 deletions doc/migrations/4.0.0_4.0.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## TOML configuration file

After the latest [MongooseIM 4.0.0](https://github.com/esl/MongooseIM/releases/tag/4.0.0) release that announced the new TOML configuration format, we've changed a few configuration formats:

* Removed the backend option for `mod_bosh` as "mnesia" was the only valid option.
* Removed the backend option for `mod_inbox` as "rdbms" was the only valid option.
* Deprecated `mod_revproxy`, it can now only be configured with the older, `.cfg` configuration file. Please refer to the older versions of the documentation to see how to do this.
* For `mod_global_distrib`:
* Replaced the `bounce` option with `bounce.enabled` for `mod_global_distrib`. It was a "boolean with only false being a valid option" which was very confusing. This was because when someone wanted to have bounce enabled it became a TOML table as opposed to a key. Now there is a switch in the bounce section for this behaviour which keeps the behaviour of having bounce enabled by default.
* Replaced the `tls` option with `tls.enabled` for `mod_global_distrib` for the same reason. The only issue here is as tls is disabled by default (it needs some options in the tls section to be set), the "no section - disabled" approach seems more natural. Just for the consistency, it's changed to be similar to the bounce section in this regard.


## `mod_http_notification` module is no longer available

`mod_http_notification` has been deprecated since MongooseIM 2.1.1 and it is no longer available in this release.
Please use the `http` backend for `mod_event_pusher`, which is the direct equivalent of `mod_http_notification`.

### Metrics

`mod_http_notification` metric was updated and now is available as [`mod_event_pusher_http`](../../modules/mod_event_pusher_http/#metrics).
For more details on how to configure `mod_event_pusher` with `http` backend, please see [this section](../../modules/mod_event_pusher_http/).
10 changes: 0 additions & 10 deletions doc/migrations/4.0.0_4.X.X.md

This file was deleted.

0 comments on commit 5cb7ef8

Please sign in to comment.