Skip to content

Commit

Permalink
Add test to assert CHANGELOG format
Browse files Browse the repository at this point in the history
  • Loading branch information
jderusse committed Oct 5, 2023
1 parent 6dd43df commit c94c1eb
Show file tree
Hide file tree
Showing 48 changed files with 414 additions and 221 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/bin/refresh
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ foreach ($services as $service => $hasChange) {
$changeLog = explode("\n", file_get_contents($changeLogPath));
$nrSection = false;
$fixSection = false;
$fixSectionLabel = $hasChange ? '### Added' : '### Changed';
$fixSectionLabel = $hasChange ? '### Added' : '### Fixed';

foreach ($changeLog as $index => $line) {
if ($line === '## NOT RELEASED') {
Expand Down
36 changes: 13 additions & 23 deletions src/Core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## NOT RELEASED

### Changed
### Fixed

- Allow passing explicit null values for optional fields of input objects

Expand All @@ -16,7 +16,7 @@
- Support for SSO credentials
- Avoid overriding the exception message with the raw message

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand All @@ -36,7 +36,7 @@

## 1.18.1

### Changed
### Fixed

- AWS enhancement: Documentation updates.
- Fix deprecation by adding return type on reset methods
Expand Down Expand Up @@ -73,7 +73,7 @@
- Added an AwsHttpClientFactory to help people creating retryable clients
- Add 403 errors in the list of potential retryiable operations

### Changed
### Fixed

- Set default value to `false` for the `sendChunkedBody` option.

Expand Down Expand Up @@ -165,6 +165,8 @@

## 1.7.2

### Fixed

- Make sure we can get credentials even if the cache storage fails
- Clear `realpath` cache to make sure we get the latest credentials token

Expand Down Expand Up @@ -239,9 +241,6 @@
### Fixed

- Allows non-AWS regions when using custom endpoints

### Changed

- Add more context to error logs
- Log level for 404 responses changed to "info".

Expand All @@ -255,9 +254,6 @@
- Add a `Credential::adjustExpireDate` method for adjusting the time according to the time difference with AWS clock
- 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

- 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
- Protected methods `getServiceCode`, `getSignatureVersion` and `getSignatureScopeName` of AbstractApi are deprecated and will be removed in 2.0
Expand Down Expand Up @@ -334,14 +330,14 @@
- Internal `AsyncAws\Core\RequestContext`.
- Internal `AsyncAws\Core\Stream\RewindableStream`.

### Removed
### BC-BREAK

- 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
### Fixed

- Exceptions will contain more information from the HTTP response.
- Moved STS value objects to a dedicated namespace.
Expand All @@ -353,9 +349,6 @@
- Renamed `AsyncAws\Core\Stream\Stream` to `AsyncAws\Core\Stream\RequestStream`.
- Renamed `AsyncAws\Core\StreamableBodyInterface` to `AsyncAws\Core\Stream\ResultStream`.
- The `ResultStream::getChunks()` now returns a iterable of string.

### Fixed

- Bugfix in `WebIdentityProvider`

## 0.4.0
Expand All @@ -364,23 +357,20 @@

- Test class `AsyncAws\Core\Test\SimpleStreamableBody`

### Changed
### Fixed

- Moved `AsyncAws\Core\Signer\Request` to `AsyncAws\Core\Request`.
- Added constructor argument to `AsyncAws\Core\Request::__construct()` to support query parameters.
- Renamed `AsyncAws\Core\Request::getUrl()` to `AsyncAws\Core\Request::getEndpoint()`
- Class `AsyncAws\Core\Stream\StreamFactory` is not internal anymore.
- Removed `requestBody()`, `requestHeaders()`, `requestQuery()` and `requestUri()` input classes. They are replaced with `request()`.
- Fix Instance Provider Role fetching

### Removed
### BC-BREAK

- Public `AbstractApi::request()` was removed.
- Protected function `AbstractApi::getEndpoint()` was made private.

### Fixed

- Fix Instance Provider Role fetching

## 0.3.3

### Added
Expand Down Expand Up @@ -415,7 +405,7 @@
- Streamable request accepts iterable alongside string, callable, resource
- Support for getting credentials from Web Identity or OpenID Connect Federation. (`WebIdentityProvider`)

### Changed
### Fixed

- Rename namespace `Signers` into `Signer`.

Expand All @@ -428,7 +418,7 @@
- Protected methods `Result::registerPrefetch()` and `Result::unregisterPrefetch()`
- Timeout parameter to `InstanceProvider::__construct()`

### Changed
### Fixed

- Removed `AwsClient` and replaced it with `AwsClientFactory`
- Class `AsyncAws\Core\Signer\Request` is marked as internal
Expand Down
9 changes: 3 additions & 6 deletions src/Integration/Aws/DynamoDbSession/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,21 @@

## 1.0.2

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

## 1.0.1

### Updated
### Fixed

- Fix deprecations triggered by php 8.1

## 1.0.0

### Updated

- Use async-aws/dynamo-db: ^1.0

### Fixed

- Use async-aws/dynamo-db: ^1.0
- Make sure we throw exception from async-aws/core

## 0.1.2
Expand Down
6 changes: 3 additions & 3 deletions src/Integration/Aws/SimpleS3/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

## 2.0.0

### BC Break
### BC-BREAK

- Upgrade to `async-aws/s3` 2.0

## 1.1.1

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand All @@ -22,7 +22,7 @@

## 1.0.0

No changes since 0.1.2.
- Empty release

## 0.1.2

Expand Down
2 changes: 1 addition & 1 deletion src/Integration/Laravel/Cache/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 0.2.1

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand Down
4 changes: 2 additions & 2 deletions src/Integration/Laravel/Queue/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## 0.2.1

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand All @@ -22,7 +22,7 @@

## 0.1.2

### Changed
### Fixed

- Let `SqsClient` choose the right HttpClient.

Expand Down
11 changes: 4 additions & 7 deletions src/Integration/Monolog/CloudWatch/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,21 @@

## 1.0.2

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

## 1.0.1

### Updated
### Fixed

- Remove unnecessary sequenceToken from log events

## 1.0.0

### Updated

- Use async-aws/cloud-watch-logs: ^1.0

### Fixed

- Use async-aws/cloud-watch-logs: ^1.0
- Make sure we throw exception from async-aws/core

## 0.2.1
Expand All @@ -32,7 +29,7 @@

## 0.2.0

### Deprecation
### Fixed

- `CloudWatchLogsHandler` constructor arguments changed

Expand Down
6 changes: 3 additions & 3 deletions src/Integration/Symfony/Bundle/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- Support for LocationService
- Support for SSO

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand Down Expand Up @@ -85,7 +85,7 @@

- Support for ECR client.

### Changed
### Fixed

- Added channel "async_aws" to Monolog logger.

Expand Down Expand Up @@ -130,7 +130,7 @@

## 0.2.3

### Changed
### Fixed

- Support only version 1.0 of async-aws/core

Expand Down
4 changes: 2 additions & 2 deletions src/Service/AppSync/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## NOT RELEASED

### Changed
### Fixed

- Allow passing explicit null values for optional fields of input objects

Expand All @@ -21,7 +21,7 @@
- Avoid overriding the exception message with the raw message
- Use int as the PHP representation of long fields in generated code

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand Down
4 changes: 2 additions & 2 deletions src/Service/Athena/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## NOT RELEASED

### Changed
### Fixed

- Allow passing explicit null values for optional fields of input objects

Expand All @@ -28,7 +28,7 @@
- Avoid overriding the exception message with the raw message
- Use int as the PHP representation of long fields in generated code

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand Down
16 changes: 8 additions & 8 deletions src/Service/CloudFormation/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## NOT RELEASED

### Changed
### Fixed

- Allow passing explicit null values for optional fields of input objects
- AWS enhancement: Documentation updates.
Expand All @@ -14,7 +14,7 @@
- AWS enhancement: Documentation updates.
- AWS api-change: This SDK release is for the feature launch of AWS CloudFormation RetainExceptOnCreate. It adds a new parameter retainExceptOnCreate in the following APIs: CreateStack, UpdateStack, RollbackStack, ExecuteChangeSet.

### Changed
### Fixed

- Improve parameter type and return type in phpdoc

Expand Down Expand Up @@ -68,7 +68,7 @@

## 0.5.0

### Removed
### BC-BREAK

- Removes methods `getServiceCode`, `getSignatureVersion` and `getSignatureScopeName` from Client.

Expand All @@ -78,20 +78,20 @@

## 0.4.1

### Changed
### Fixed

- Support only version 1.0 of async-aws/core

## 0.4.0

### Changed
### Fixed

- 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
### BC-BREAK

- Dependency on `symfony/http-client-contracts`
- All `validate()` methods on the inputs. They are merged with `request()`.
Expand All @@ -102,14 +102,14 @@

- Enums; `Capability`, `ResourceStatus`, `StackDriftStatus`, `StackStatus`

### Changed
### Fixed

- Removed `requestBody()`, `requestHeaders()`, `requestQuery()` and `requestUri()` input classes. They are replaced with `request()`.
- Using async-aws/core: 0.4.0

## 0.2.0

### Changed
### Fixed

- Using async-aws/core: 0.3.0

Expand Down
Loading

0 comments on commit c94c1eb

Please sign in to comment.