Skip to content

Commit 3f51e20

Browse files
author
cakepietoast
authored
chore: reformat changelog to follow KeepAChangelog standard (#50)
1 parent 95998c9 commit 3f51e20

File tree

1 file changed

+48
-56
lines changed

1 file changed

+48
-56
lines changed

Diff for: CHANGELOG.md

+48-56
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,34 @@
1-
# HISTORY
1+
# Changelog
2+
All notable changes to this project will be documented in this file.
23

3-
## May 29th
4+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
5+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
46

5-
**0.9.4**
7+
## [Unreleased]
68

7-
* **Metrics**: Bugfix - Metrics were not correctly flushed, and cleared on every invocation
9+
## [0.9.4] - 2020-05-29
10+
### Fixed
11+
- **Metrics**: Fix issue where metrics were not correctly flushed, and cleared on every invocation
812

9-
## May 16th
13+
## [0.9.3] - 2020-05-16
14+
### Fixed
15+
- **Tracer**: Fix Runtime Error for nested sync due to incorrect loop usage
1016

11-
**0.9.3**
17+
## [0.9.2] - 2020-05-14
18+
### Fixed
19+
- **Tracer**: Import aiohttp lazily so it's not a hard dependency
1220

13-
* **Tracer**: Bugfix - Runtime Error for nested sync due to incorrect loop usage
14-
15-
## May 14th
16-
17-
**0.9.2**
18-
19-
* **Tracer**: Bugfix - aiohttp lazy import so it's not a hard dependency
20-
21-
## May 12th
22-
23-
**0.9.0**
24-
25-
* **Tracer**: Support for async functions in `Tracer` via `capture_method` decorator
26-
* **Tracer**: Support for `aiohttp` via `aiohttp_trace_config` trace config
27-
* **Tracer**: Support for patching specific modules via `patch_modules` param
28-
* **Tracer**: Document escape hatch mechanisms via `tracer.provider`
29-
30-
## May 1st
31-
32-
**0.8.1**
21+
## [0.9.0] - 2020-05-12
22+
### Added
23+
- **Tracer**: Support for async functions in `Tracer` via `capture_method` decorator
24+
- **Tracer**: Support for `aiohttp` via `aiohttp_trace_config` trace config
25+
- **Tracer**: Support for patching specific modules via `patch_modules` param
26+
- **Tracer**: Document escape hatch mechanisms via `tracer.provider`
3327

28+
## [0.8.1] - 2020-05-1
29+
### Fixed
3430
* **Metrics**: Fix metric unit casting logic if one passes plain string (value or key)
35-
* **Metrics: **Fix `MetricUnit` enum values for
31+
* **Metrics:**: Fix `MetricUnit` enum values for
3632
- `BytesPerSecond`
3733
- `KilobytesPerSecond`
3834
- `MegabytesPerSecond`
@@ -45,40 +41,36 @@
4541
- `TerabitsPerSecond`
4642
- `CountPerSecond`
4743

48-
## April 24th
49-
50-
**0.8.0**
51-
52-
* **Logger**: Introduces `Logger` class for stuctured logging as a replacement for `logger_setup`
53-
* **Logger**: Introduces `Logger.inject_lambda_context` decorator as a replacement for `logger_inject_lambda_context`
54-
* **Logger**: Raise `DeprecationWarning` exception for both `logger_setup`, `logger_inject_lambda_context`
55-
56-
## April 20th, 2020
57-
58-
**0.7.0**
59-
60-
* **Middleware factory**: Introduces Middleware Factory to build your own middleware via `lambda_handler_decorator`
61-
* **Metrics**: Fixes metrics dimensions not being included correctly in EMF
62-
63-
## April 9th, 2020
64-
65-
**0.6.3**
66-
67-
* **Logger**: Fix `log_metrics` decorator logic not calling the decorated function, and exception handling
44+
## [0.8.0] - 2020-04-24
45+
### Added
46+
- **Logger**: Introduced `Logger` class for stuctured logging as a replacement for `logger_setup`
47+
- **Logger**: Introduced `Logger.inject_lambda_context` decorator as a replacement for `logger_inject_lambda_context`
6848

69-
## April 8th, 2020
49+
### Removed
50+
- **Logger**: Raise `DeprecationWarning` exception for both `logger_setup`, `logger_inject_lambda_context`
7051

71-
**0.6.1**
52+
## [0.7.0] - 2020-04-20
53+
### Added
54+
- **Middleware factory**: Introduced Middleware Factory to build your own middleware via `lambda_handler_decorator`
7255

73-
* **Metrics**: Introduces Metrics middleware to utilise CloudWatch Embedded Metric Format
74-
* **Metrics**: Adds deprecation warning for `log_metrics`
56+
### Fixed
57+
- **Metrics**: Fixed metrics dimensions not being included correctly in EMF
7558

76-
## February 20th, 2020
59+
## [0.6.3] - 2020-04-09
60+
### Fixed
61+
- **Logger**: Fix `log_metrics` decorator logic not calling the decorated function, and exception handling
7762

78-
**0.5.0**
63+
## [0.6.1] - 2020-04-08
64+
### Added
65+
- **Metrics**: Introduces Metrics middleware to utilise CloudWatch Embedded Metric Format
7966

80-
* **Logger**: Introduces log sampling for debug - Thanks to [Danilo's contribution](https://github.com/awslabs/aws-lambda-powertools/pull/7)
67+
### Deprecated
68+
- **Metrics**: Added deprecation warning for `log_metrics`
8169

82-
## November 15th, 2019
70+
## [0.5.0] - 2020-02-20
71+
### Added
72+
- **Logger**: Introduced log sampling for debug - Thanks to [Danilo's contribution](https://github.com/awslabs/aws-lambda-powertools/pull/7)
8373

84-
* Public beta release
74+
## [0.1.0] - 2019-11-15
75+
### Added
76+
- Public beta release

0 commit comments

Comments
 (0)