Skip to content

Commit 4467786

Browse files
kevinbaderkevinbader
committed
Prepare Changelog for the 2.0.0-beta.2 release
1 parent d366066 commit 4467786

File tree

1 file changed

+127
-91
lines changed

1 file changed

+127
-91
lines changed

‎CHANGELOG.md‎

Lines changed: 127 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,129 @@
11
# Changelog
22

3-
## v2.0.0-dev
4-
5-
- Added
6-
- [Auth] JWT now supports RS256 algorithm in addition to HS256. [#84](https://github.com/Accenture/reactive-interaction-gateway/issues/84)
7-
- [Outbound] Support Kafka SSL and SASL/Plain authentication. [#79](https://github.com/Accenture/reactive-interaction-gateway/issues/79)
8-
- [Inbound] SSE heartbeats are now sent as comments rather than events, and events without data carry an empty data line to improve cross-browser compatibility. [#64](https://github.com/Accenture/reactive-interaction-gateway/issues/64)
9-
- [Inbound] Add new endpoints at `/_rig/v1/` for subscribing to CloudEvents using SSE/WS, for creating subscriptions to specific event types, and for publishing CloudEvents. [#90](https://github.com/Accenture/reactive-interaction-gateway/issues/90)
10-
- [Inbound] Expose setting for proxy response timeout. [#91](https://github.com/Accenture/reactive-interaction-gateway/issues/91)
11-
- [Inbound] Subscriptions inference using JWT on SSE/WS connection and subscription creation. [#90](https://github.com/Accenture/reactive-interaction-gateway/issues/90)
12-
- [Inbound] Allow publishing events to Kafka and Kinesis via reverse-proxy HTTP calls. Optionally, a response can be waited for (using a correlation ID).
13-
- [Docs] Simple event subscription examples for SSE and WS.
14-
- [Outbound] Kafka/Kinesis firehose - set topic/stream to consume and invoke HTTP request when event is consumed.
15-
16-
- Fixed
17-
- [Inbound] Flaky tests in `router_test.exs` -- switching from `Bypass` to `Fakeserver`. [#74](https://github.com/Accenture/reactive-interaction-gateway/issues/74)
18-
- [Docs] Channels example. [#64]https://github.com/Accenture/reactive-interaction-gateway/issues/64
19-
20-
- Changed
21-
- [Docs] General documentation and outdated info.
22-
23-
- Deprecated
24-
- [Inbound] Previous SSE/WS communication via Phoenix channels.
25-
26-
## v2.0.0-beta.1
27-
28-
- Changed
29-
- [Api] Endpoint for terminating a session no longer contains user id in path
30-
- [Misc] Convert to umbrella project layout
31-
- [Docs] Move documentation from `doc/` to `guides/` as the former is the default for ex_doc output
32-
- [Inbound] Revised request logging (currently Kafka and console as backends)
33-
- [Inbound] Disable WebSocket timeout - [#58](https://github.com/Accenture/reactive-interaction-gateway/pull/58)
34-
- [Deploy] Dockerfile to use custom `vm.args` file & removed `mix release.init` step - [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
35-
36-
- Added
37-
- [Outbound] Amazon Kinesis integration - [#27](https://github.com/Accenture/reactive-interaction-gateway/issues/27)
38-
- [Misc] Use lazy logger calls for debug logs
39-
- [Misc] Format (most files) using Elixir 1.6 formatter
40-
- [API/Outbound] Add new endpoint `POST /messages` for sending messages (=> Kafka is no longer a hard dependency)
41-
- [Docs] Add a dedicated developer guide
42-
- [Deploy] Release configuration in `rel/config.exs` and custom `vm.args` (based on what distillery is using) - [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
43-
- [Deploy] Production configuration for peerage to use DNS discovery - [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
44-
- [Rig] Module for auto-discovery, using `Peerage` library - [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
45-
- [Deploy] Kubernetes deployment configuration file - [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
46-
- [Misc] Smoke tests setup and test cases for API Proxy and Kafka + Phoenix messaging - [#42](https://github.com/Accenture/reactive-interaction-gateway/pull/42)
47-
- [Outbound] Kafka consumer ready check utility function - [#42](https://github.com/Accenture/reactive-interaction-gateway/pull/42)
48-
- [Docs] List of all environment variables possible to set in `guides/operator-guide.md` - [#36](https://github.com/Accenture/reactive-interaction-gateway/pull/36)
49-
- [Rig] Possibility to set logging level with env var `LOG_LEVEL` - [#49](https://github.com/Accenture/reactive-interaction-gateway/pull/49)
50-
- [Deploy] Variations of Dockerfiles - basic version and AWS version - [#44](https://github.com/Accenture/reactive-interaction-gateway/pull/44)
51-
- [Deploy] Helm deployment chart - [#59](https://github.com/Accenture/reactive-interaction-gateway/pull/59)
52-
- [Inbound] Proxy is now able to do request header transformations - [#76](https://github.com/Accenture/reactive-interaction-gateway/pull/76)
53-
54-
- Fixed
55-
- [Inbound] Make presence channel respect `JWT_USER_FIELD` setting (currently hardcoded to "username")
56-
- [Inbound] Set proper environment variable for Phoenix server `INBOUND_PORT` - [#38](https://github.com/Accenture/reactive-interaction-gateway/pull/38)
57-
- [API] Set proper environment variable for Phoenix server `API_PORT` - [#38](https://github.com/Accenture/reactive-interaction-gateway/pull/38)
58-
- [Examples] Channels example fixed to be compatible with version 2.0.0 [#40](https://github.com/Accenture/reactive-interaction-gateway/pull/40)
59-
- [Inbound] User defined query auth values are no longer overridden by `JWT` auth type
60-
- [Outbound] Handle content-type correctly - [#61](https://github.com/Accenture/reactive-interaction-gateway/pull/61)
61-
- [Inbound] More strict regex match for routes in proxy - [#76](https://github.com/Accenture/reactive-interaction-gateway/pull/76)
62-
- [Inbound] Downcased response headers to avoid duplicates in proxy - [#76](https://github.com/Accenture/reactive-interaction-gateway/pull/76)
63-
64-
- Deprecated
65-
66-
## v1.1.0 (January 11, 2018)
67-
68-
- Changed
69-
- [Config] Increase default rate limits - [#16](https://github.com/Accenture/reactive-interaction-gateway/pull/16)
70-
- [Kafka] Make producing of Kafka messages in proxy optional (and turned off by default) - [#21](https://github.com/Accenture/reactive-interaction-gateway/pull/21)
71-
72-
- Added
73-
- [Deploy] Basic Travis configuration - [#17](https://github.com/Accenture/reactive-interaction-gateway/pull/17)
74-
- [Docs] Configuration ADR document - [#19](https://github.com/Accenture/reactive-interaction-gateway/pull/19)
75-
- [Docs] Websocket and SSE channels example - [#22](https://github.com/Accenture/reactive-interaction-gateway/pull/22)
76-
- [Deploy] Maintain changelog file - [#25](https://github.com/Accenture/reactive-interaction-gateway/pull/25)
77-
78-
- Fixed
79-
- [Config] Fix Travis by disabling credo rule `Design.AliasUsage` - [#18](https://github.com/Accenture/reactive-interaction-gateway/pull/18)
80-
81-
## v1.0.0 (November 9, 2017)
82-
83-
- Changed
84-
- [Config] Update configuration to be able to modify almost anything by environment variables on RIG start - [#5](https://github.com/Accenture/reactive-interaction-gateway/pull/5)
85-
- [Deploy] Rework Dockerfile to use multistage approach for building RIG Docker image - [#9](https://github.com/Accenture/reactive-interaction-gateway/pull/9)
86-
- [Config] Update entire code base to use `rig` keyword - [#13](https://github.com/Accenture/reactive-interaction-gateway/pull/13)
87-
88-
- Added
89-
- [Docs] Add `mix docs` script to generate documentation of code base - [#6](https://github.com/Accenture/reactive-interaction-gateway/pull/6)
90-
- [Docs] Add ethics documentation such as code of conduct and contribution guidelines - [#6](https://github.com/Accenture/reactive-interaction-gateway/pull/6)
91-
92-
- Removed
93-
- [Config] Disable Origin checking - [#12](https://github.com/Accenture/reactive-interaction-gateway/pull/12)
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [Unreleased]
9+
10+
<!-- ### Added -->
11+
12+
<!-- ### Changed -->
13+
14+
<!-- ### Deprecated -->
15+
16+
<!-- ### Removed -->
17+
18+
<!-- ### Fixed -->
19+
20+
<!-- ### Security -->
21+
22+
## [2.0.0-beta.2] - 2018-11-09
23+
24+
### Added
25+
26+
- [Auth] JWT now supports RS256 algorithm in addition to HS256. [#84](https://github.com/Accenture/reactive-interaction-gateway/issues/84)
27+
- [Outbound] Support Kafka SSL and SASL/Plain authentication. [#79](https://github.com/Accenture/reactive-interaction-gateway/issues/79)
28+
- [Inbound] Add new endpoints at `/_rig/v1/` for subscribing to CloudEvents using SSE/WS, for creating subscriptions to specific event types, and for publishing CloudEvents. [#90](https://github.com/Accenture/reactive-interaction-gateway/issues/90)
29+
- [Inbound] Expose setting for proxy response timeout. [#91](https://github.com/Accenture/reactive-interaction-gateway/issues/91)
30+
- [Inbound] Subscriptions inference using JWT on SSE/WS connection and subscription creation. [#90](https://github.com/Accenture/reactive-interaction-gateway/issues/90)
31+
- [Inbound] Allow publishing events to Kafka and Kinesis via reverse-proxy HTTP calls. Optionally, a response can be waited for (using a correlation ID).
32+
- [Docs] Simple event subscription examples for SSE and WS.
33+
- [Outbound] Kafka/Kinesis firehose - set topic/stream to consume and invoke HTTP request when event is consumed.
34+
35+
### Changed
36+
37+
- [Inbound] SSE heartbeats are now sent as comments rather than events, and events without data carry an empty data line to improve cross-browser compatibility. [#64](https://github.com/Accenture/reactive-interaction-gateway/issues/64)
38+
- [Docs] General documentation and outdated info.
39+
40+
### Removed
41+
42+
- [Inbound] Previous SSE/WS communication via Phoenix channels.
43+
- Events that don't follow the CloudEvents spec are no longer supported (easy migration: put your event in a CloudEvent's `data` field).
44+
45+
### Fixed
46+
47+
- [Inbound] Flaky tests in `router_test.exs` -- switching from `Bypass` to `Fakeserver`. [#74](https://github.com/Accenture/reactive-interaction-gateway/issues/74)
48+
- [Docs] Channels example. [#64]https://github.com/Accenture/reactive-interaction-gateway/issues/64
49+
50+
## [2.0.0-beta.1] - 2018-06-21
51+
52+
### Added
53+
54+
- [Outbound] Amazon Kinesis integration. [#27](https://github.com/Accenture/reactive-interaction-gateway/issues/27)
55+
- [Misc] Use lazy logger calls for debug logs.
56+
- [Misc] Format (most files) using Elixir 1.6 formatter.
57+
- [API/Outbound] Add new endpoint `POST /messages` for sending messages (=> Kafka is no longer a hard dependency).
58+
- [Docs] Add a dedicated developer guide.
59+
- [Deploy] Release configuration in `rel/config.exs` and custom `vm.args` (based on what distillery is using). [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
60+
- [Deploy] Production configuration for peerage to use DNS discovery. [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
61+
- [Rig] Module for auto-discovery, using `Peerage` library. [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
62+
- [Deploy] Kubernetes deployment configuration file. [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
63+
- [Misc] Smoke tests setup and test cases for API Proxy and Kafka + Phoenix messaging. [#42](https://github.com/Accenture/reactive-interaction-gateway/pull/42)
64+
- [Outbound] Kafka consumer ready check utility function. [#42](https://github.com/Accenture/reactive-interaction-gateway/pull/42)
65+
- [Docs] List of all environment variables possible to set in `guides/operator-guide.md`. [#36](https://github.com/Accenture/reactive-interaction-gateway/pull/36)
66+
- [Rig] Possibility to set logging level with env var `LOG_LEVEL`. [#49](https://github.com/Accenture/reactive-interaction-gateway/pull/49)
67+
- [Deploy] Variations of Dockerfiles - basic version and AWS version. [#44](https://github.com/Accenture/reactive-interaction-gateway/pull/44)
68+
- [Deploy] Helm deployment chart. [#59](https://github.com/Accenture/reactive-interaction-gateway/pull/59)
69+
- [Inbound] Proxy is now able to do request header transformations. [#76](https://github.com/Accenture/reactive-interaction-gateway/pull/76)
70+
71+
### Changed
72+
73+
- [Api] Endpoint for terminating a session no longer contains user id in path.
74+
- [Misc] Convert to umbrella project layout.
75+
- [Docs] Move documentation from `doc/` to `guides/` as the former is the default for ex_doc output.
76+
- [Inbound] Revised request logging (currently Kafka and console as backends).
77+
- [Inbound] Disable WebSocket timeout. [#58](https://github.com/Accenture/reactive-interaction-gateway/pull/58)
78+
- [Deploy] Dockerfile to use custom `vm.args` file & removed `mix release.init` step. [#29](https://github.com/Accenture/reactive-interaction-gateway/pull/29)
79+
80+
### Fixed
81+
82+
- [Inbound] Make presence channel respect `JWT_USER_FIELD` setting (currently hardcoded to "username")
83+
- [Inbound] Set proper environment variable for Phoenix server `INBOUND_PORT` - [#38](https://github.com/Accenture/reactive-interaction-gateway/pull/38)
84+
- [API] Set proper environment variable for Phoenix server `API_PORT` - [#38](https://github.com/Accenture/reactive-interaction-gateway/pull/38)
85+
- [Examples] Channels example fixed to be compatible with version 2.0.0 [#40](https://github.com/Accenture/reactive-interaction-gateway/pull/40)
86+
- [Inbound] User defined query auth values are no longer overridden by `JWT` auth type
87+
- [Outbound] Handle content-type correctly - [#61](https://github.com/Accenture/reactive-interaction-gateway/pull/61)
88+
- [Inbound] More strict regex match for routes in proxy - [#76](https://github.com/Accenture/reactive-interaction-gateway/pull/76)
89+
- [Inbound] Downcased response headers to avoid duplicates in proxy - [#76](https://github.com/Accenture/reactive-interaction-gateway/pull/76)
90+
91+
## [1.1.0] - 2018-01-11
92+
93+
### Added
94+
95+
- [Deploy] Basic Travis configuration. [#17](https://github.com/Accenture/reactive-interaction-gateway/pull/17)
96+
- [Docs] Configuration ADR document. [#19](https://github.com/Accenture/reactive-interaction-gateway/pull/19)
97+
- [Docs] Websocket and SSE channels example. [#22](https://github.com/Accenture/reactive-interaction-gateway/pull/22)
98+
- [Deploy] Maintain changelog file. [#25](https://github.com/Accenture/reactive-interaction-gateway/pull/25)
99+
100+
### Changed
101+
102+
- [Config] Increase default rate limits. [#16](https://github.com/Accenture/reactive-interaction-gateway/pull/16)
103+
- [Kafka] Make producing of Kafka messages in proxy optional (and turned off by default). [#21](https://github.com/Accenture/reactive-interaction-gateway/pull/21)
104+
105+
### Fixed
106+
107+
- [Config] Fix Travis by disabling credo rule `Design.AliasUsage`. [#18](https://github.com/Accenture/reactive-interaction-gateway/pull/18)
108+
109+
## 1.0.0 - 2017-11-09
110+
111+
### Added
112+
113+
- [Docs] Add `mix docs` script to generate documentation of code base. [#6](https://github.com/Accenture/reactive-interaction-gateway/pull/6)
114+
- [Docs] Add ethics documentation such as code of conduct and contribution guidelines. [#6](https://github.com/Accenture/reactive-interaction-gateway/pull/6)
115+
116+
### Changed
117+
118+
- [Config] Update configuration to be able to modify almost anything by environment variables on RIG start. [#5](https://github.com/Accenture/reactive-interaction-gateway/pull/5)
119+
- [Deploy] Rework Dockerfile to use multistage approach for building RIG Docker image. [#9](https://github.com/Accenture/reactive-interaction-gateway/pull/9)
120+
- [Config] Update entire code base to use `rig` keyword. [#13](https://github.com/Accenture/reactive-interaction-gateway/pull/13)
121+
122+
### Removed
123+
124+
- [Config] Disable Origin checking. [#12](https://github.com/Accenture/reactive-interaction-gateway/pull/12)
125+
126+
[unreleased]: https://github.com/Accenture/reactive-interaction-gateway/compare/2.0.0-beta.2...HEAD
127+
[2.0.0-beta.2]: https://github.com/Accenture/reactive-interaction-gateway/compare/2.0.0-beta.1...2.0.0-beta.2
128+
[2.0.0-beta.1]: https://github.com/Accenture/reactive-interaction-gateway/compare/1.1.0...2.0.0-beta.1
129+
[1.1.0]: https://github.com/Accenture/reactive-interaction-gateway/compare/1.0.0...1.1.0

0 commit comments

Comments
 (0)