Add test to assert CHANGELOG format (#1582)

Author: jderusse

.github/workflows/ci.yml

@@ -148,6 +148,8 @@ jobs:
 
       - name: Checkout code
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
 
       - name: Initialize tests
         run: make initialize -j 4

src/Core/CHANGELOG.md

@@ -165,6 +165,8 @@
 
 ## 1.7.2
 
+### Changed
+
 - Make sure we can get credentials even if the cache storage fails
 - Clear `realpath` cache to make sure we get the latest credentials token
 
@@ -236,15 +238,15 @@
 - Support for CloudFront in `AwsClientFactory`
 - Support for RdsDataService in `AwsClientFactory`
 
-### Fixed
-
-- Allows non-AWS regions when using custom endpoints
-
 ### Changed
 
 - Add more context to error logs
 - Log level for 404 responses changed to "info".
 
+### Fixed
+
+- Allows non-AWS regions when using custom endpoints
+
 ## 1.2.0
 
 ### Added
@@ -256,7 +258,7 @@
 - Support for global and regional endpoints
 - Add a `Configuration::optionExists` to allow third parties to check if an option is available (needed by libraries supporting several versions of core)
 
-### Deprecation
+### Deprecated
 
 - Clients extending `AbstractApi` should override `getEndpointMetata`. The method will be abstract in 2.0
 - Custom endpoints should not contain `%region%` and `%service` placeholder. They won't be replaced anymore in 2.0
@@ -321,6 +323,13 @@
 
 ## 0.5.0
 
+### Removed
+
+- The input's `validate()` function was merged with the `request()` function.
+- `Configuration::isDefault()`.
+- Protected property `AbstractApi::$logger`.
+- `AsyncAws\Core\StreamableBody` in favor of `AsyncAws\Core\Stream\ResponseBodyStream`.
+
 ### Added
 
 - Add support for multiregion via `@region` input parameter.
@@ -334,13 +343,6 @@
 - Internal `AsyncAws\Core\RequestContext`.
 - Internal `AsyncAws\Core\Stream\RewindableStream`.
 
-### Removed
-
-- The input's `validate()` function was merged with the `request()` function.
-- `Configuration::isDefault()`.
-- Protected property `AbstractApi::$logger`.
-- `AsyncAws\Core\StreamableBody` in favor of `AsyncAws\Core\Stream\ResponseBodyStream`.
-
 ### Changed
 
 - Exceptions will contain more information from the HTTP response.
@@ -360,6 +362,11 @@
 
 ## 0.4.0
 
+### Removed
+
+- Public `AbstractApi::request()` was removed.
+- Protected function `AbstractApi::getEndpoint()` was made private.
+
 ### Added
 
 - Test class `AsyncAws\Core\Test\SimpleStreamableBody`
@@ -372,11 +379,6 @@
 - Class `AsyncAws\Core\Stream\StreamFactory` is not internal anymore.
 - Removed `requestBody()`, `requestHeaders()`, `requestQuery()` and `requestUri()` input classes. They are replaced with `request()`.
 
-### Removed
-
-- Public `AbstractApi::request()` was removed.
-- Protected function `AbstractApi::getEndpoint()` was made private.
-
 ### Fixed
 
 - Fix Instance Provider Role fetching

src/Integration/Aws/DynamoDbSession/CHANGELOG.md

@@ -10,13 +10,13 @@
 
 ## 1.0.1
 
-### Updated
+### Changed
 
 - Fix deprecations triggered by php 8.1
 
 ## 1.0.0
 
-### Updated
+### Changed
 
 - Use async-aws/dynamo-db: ^1.0
 

src/Integration/Aws/SimpleS3/CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ## 2.0.0
 
-### BC Break
+### BC-BREAK
 
 - Upgrade to `async-aws/s3` 2.0
 
@@ -22,7 +22,7 @@
 
 ## 1.0.0
 
-No changes since 0.1.2.
+- Empty release
 
 ## 0.1.2
 

src/Integration/Monolog/CloudWatch/CHANGELOG.md

@@ -10,13 +10,13 @@
 
 ## 1.0.1
 
-### Updated
+### Changed
 
 - Remove unnecessary sequenceToken from log events
 
 ## 1.0.0
 
-### Updated
+### Changed
 
 - Use async-aws/cloud-watch-logs: ^1.0
 
@@ -32,7 +32,7 @@
 
 ## 0.2.0
 
-### Deprecation
+### Deprecated
 
 - `CloudWatchLogsHandler` constructor arguments changed
 

src/Service/Athena/CHANGELOG.md

@@ -2,14 +2,14 @@
 
 ## NOT RELEASED
 
-### Changed
-
-- Allow passing explicit null values for optional fields of input objects
-
 ### Added
 
 - Added `il-central-1` region
 
+### Changed
+
+- Allow passing explicit null values for optional fields of input objects
+
 ## 2.0.0
 
 ### BC-BREAK

src/Service/CloudFormation/CHANGELOG.md

@@ -84,18 +84,18 @@
 
 ## 0.4.0
 
+### Removed
+
+- Dependency on `symfony/http-client-contracts`
+- All `validate()` methods on the inputs. They are merged with `request()`.
+
 ### Changed
 
 - Moved value objects to a dedicated namespace.
 - Results' `populateResult()` has only one argument. It takes a `AsyncAws\Core\Response`.
 - Using `DateTimeImmutable` instead of `DateTimeInterface`
 - The `AsyncAws\CloudFormation\Enum\*`, `AsyncAws\CloudFormation\Input\*` and `AsyncAws\CloudFormation\ValueObject*` classes are marked final.
 
-### Removed
-
-- Dependency on `symfony/http-client-contracts`
-- All `validate()` methods on the inputs. They are merged with `request()`.
-
 ## 0.3.0
 
 ### Added

src/Service/CloudWatchLogs/CHANGELOG.md

@@ -51,15 +51,15 @@
 
 ## 1.2.0
 
-### Fixed
-
-- Assert the provided Input can be json-encoded.
-
 ### Added
 
 - AWS api-change: Update documentation
 - Added operation `createLogGroup`
 
+### Fixed
+
+- Assert the provided Input can be json-encoded.
+
 ## 1.1.0
 
 ### Added

src/Service/DynamoDb/CHANGELOG.md

@@ -106,14 +106,14 @@
 
 ## 0.3.0
 
-### Added
-
-- Added operation `UpdateTimeToLiveInput`
-
 ### Removed
 
 - Removes methods `getServiceCode`, `getSignatureVersion` and `getSignatureScopeName` from Client.
 
+### Added
+
+- Added operation `UpdateTimeToLiveInput`
+
 ### Fixed
 
 - Add return typehint for `listTables`, `query` and `scan`

src/Service/Ecr/CHANGELOG.md

@@ -10,16 +10,13 @@
 
 ### Added
 
+- AWS api-change: Add support for the `il-central-1` region
 - Avoid overriding the exception message with the raw message
 
 ### Changed
 
 - Improve parameter type and return type in phpdoc
 
-### Added
-
-- AWS api-change: Add support for the `il-central-1` region
-
 ## 1.4.0
 
 ### Added
@@ -48,15 +45,15 @@
 
 ## 1.0.0
 
-### Fixed
-
-- Assert the provided Input can be json-encoded.
-
 ### Added
 
 - AWS api-change: Added `ap-northeast-3` region
 - AWS enhancement: Documentation updates
 
+### Fixed
+
+- Assert the provided Input can be json-encoded.
+
 ## 0.1.2
 
 ### Added
@@ -66,14 +63,14 @@
 
 ## 0.1.1
 
-### Fixed
-
-- AWS api-change: Added us-isob-east-1 region
-
 ### Deprecated
 
 - AWS api-change: `GetAuthorizationTokenRequest::$registryIds` has been deprecated
 
+### Fixed
+
+- AWS api-change: Added us-isob-east-1 region
+
 ## 0.1.0
 
 First version

src/Service/EventBridge/CHANGELOG.md

@@ -40,15 +40,15 @@
 
 ## 1.2.0
 
-### Fixed
-
-- Assert the provided Input can be json-encoded.
-
 ### Added
 
 - AWS api-change: Adds TraceHeader to PutEventsRequestEntry to support AWS X-Ray trace-ids on events generated using the PutEvents operation.
 - AWS enhancement: Documentation updates
 
+### Fixed
+
+- Assert the provided Input can be json-encoded.
+
 ## 1.1.0
 
 ### Added

src/Service/Lambda/CHANGELOG.md

@@ -79,18 +79,18 @@
 
 ## 1.5.0
 
-### Fixed
+### Added
 
-- Assert the provided Input can be json-encoded.
+- AWS api-change: Lambda Python 3.9 runtime launch
+- AWS api-change: Adds support for Lambda functions powered by AWS Graviton2 processors. Customers can now select the CPU architecture for their functions.
 
 ### Changed
 
 - AWS enhancement: Documentation updates for Amazon Lambda.
 
-### Added
+### Fixed
 
-- AWS api-change: Lambda Python 3.9 runtime launch
-- AWS api-change: Adds support for Lambda functions powered by AWS Graviton2 processors. Customers can now select the CPU architecture for their functions.
+- Assert the provided Input can be json-encoded.
 
 ## 1.4.0
 
@@ -154,18 +154,18 @@
 
 ## 0.4.0
 
+### Removed
+
+- Dependency on `symfony/http-client-contracts`
+- All `validate()` methods on the inputs. They are merged with `request()`.
+
 ### Changed
 
 - Moved value objects to a dedicated namespace.
 - Results' `populateResult()` has only one argument. It takes a `AsyncAws\Core\Response`.
 - Using `DateTimeImmutable` instead of `DateTimeInterface`
 - The `AsyncAws\Lambda\Enum\*`, `AsyncAws\Lambda\Input\*` and `AsyncAws\Lambda\ValueObject*` classes are marked final.
 
-### Removed
-
-- Dependency on `symfony/http-client-contracts`
-- All `validate()` methods on the inputs. They are merged with `request()`.
-
 ## 0.3.0
 
 ### Added

src/Service/LocationService/CHANGELOG.md

@@ -2,28 +2,25 @@
 
 ## NOT RELEASED
 
-### Changed
-
-- Allow passing explicit null values for optional fields of input objects
-
 ### Added
 
 - AWS api-change: Added `fips-us-gov-west-1` region
 
+### Changed
+
+- Allow passing explicit null values for optional fields of input objects
+
 ## 0.1.1
 
 ### Added
 
 - Avoid overriding the exception message with the raw message
+- AWS api-change: This release adds support for authenticating with Amazon Location Service's Places & Routes APIs with an API Key. Also, with this release developers can publish tracked device position updates to Amazon EventBridge.
 
 ### Changed
 
 - Improve parameter type and return type in phpdoc
 
-### Added
-
-- AWS api-change: This release adds support for authenticating with Amazon Location Service's Places & Routes APIs with an API Key. Also, with this release developers can publish tracked device position updates to Amazon EventBridge.
-
 ## 0.1.0
 
 First version