Skip to content

Commit c973cbb

Browse files
authored
Add Simple Changelog Management (#552)
* Rename CHANGES.md to CHANGELOG.md * Add new-entry changelog script * Add new-release changelog script * Add changelog dependency group with jinja2 dependency * Add render changelog script and changelog template * Backfill aws-sdk-signers changelog entries * Backfill smithy-aws-core changelog entries * Backfill smithy-aws-event-stream changelog entries * Backfill smithy-core changelog entries * Backfill smithy-http changelog entries * Backfill smithy-json changelog entries * fix formatting * Add license header to scripts * Address typos and formatting issues * Remove summary feature * Make version checks more consistent * Fix implementation spelling typos * Validate change type and description existence and values
1 parent 5218a12 commit c973cbb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+729
-132
lines changed
File renamed without changes.

designs/serialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ class ImplicitImplementation:
4545
return f"Good day to you {name}."
4646
```
4747

48-
Since this is *structural* subtyping, it isn't required that implmentations
48+
Since this is *structural* subtyping, it isn't required that implementations
4949
actual inheret from the `Protocol` or otherwise declare that they're
5050
implementing it. But they *can* to make it more explicit or to inherit a default
5151
implementation. The `Protocol` class itself cannot be instantiated, however.
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"changes": [
3+
{
4+
"type": "feature",
5+
"description": "Added `SigV4Signer` to sign arbitrary requests synchronously."
6+
},
7+
{
8+
"type": "feature",
9+
"description": "Added `AsyncSigV4Signer` to sign arbitrary requests asynchronously."
10+
},
11+
{
12+
"type": "feature",
13+
"description": "Added example `SigV4Auth` for integrating directly with Requests' `auth` parameter."
14+
},
15+
{
16+
"type": "feature",
17+
"description": "Added `SigV4Signer` for integrating with the AIOHTTP request workflow."
18+
},
19+
{
20+
"type": "feature",
21+
"description": "Added `SigV4Curl` for generating signed curl commands."
22+
}
23+
]
24+
}
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"changes": [
3+
{
4+
"type": "feature",
5+
"description": "Added new `content_checksum_enabled` parameter to `SigV4SigningProperties`. This will enable users to control the inclusion of the `X-Amz-Content-SHA256` header required by S3. This is disabled by _default_, so you will need to set this to `True` for any S3 requests."
6+
},
7+
{
8+
"type": "bugfix",
9+
"description": "Fixed incorrect exclusion of `X-Amz-Content-SHA256` header from some requests."
10+
}
11+
]
12+
}
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"changes": [
3+
{
4+
"type": "feature",
5+
"description": "Added `AsyncEventSigner` for Amazon Event Stream event signing."
6+
},
7+
{
8+
"type": "feature",
9+
"description": "Added new `uri_encode_path` parameter to `SigV4SigningProperties`. This boolean can be toggled to double encode the URI path."
10+
},
11+
{
12+
"type": "bugfix",
13+
"description": "Fixed bug with async seekable payloads on requests."
14+
},
15+
{
16+
"type": "bugfix",
17+
"description": "Fixed bug where paths were not being properly double-encoded."
18+
}
19+
]
20+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
## v0.0.3
4+
5+
### Features
6+
* Added `AsyncEventSigner` for Amazon Event Stream event signing.
7+
* Added new `uri_encode_path` parameter to `SigV4SigningProperties`. This boolean can be toggled to double encode the URI path.
8+
9+
### Bug fixes
10+
* Fixed bug with async seekable payloads on requests.
11+
* Fixed bug where paths were not being properly double-encoded.
12+
13+
## v0.0.2
14+
15+
### Features
16+
* Added new `content_checksum_enabled` parameter to `SigV4SigningProperties`. This will enable users to control the inclusion of the `X-Amz-Content-SHA256` header required by S3. This is disabled by _default_, so you will need to set this to `True` for any S3 requests.
17+
18+
### Bug fixes
19+
* Fixed incorrect exclusion of `X-Amz-Content-SHA256` header from some requests.
20+
21+
## v0.0.1
22+
23+
### Features
24+
* Added `SigV4Signer` to sign arbitrary requests synchronously.
25+
* Added `AsyncSigV4Signer` to sign arbitrary requests asynchronously.
26+
* Added example `SigV4Auth` for integrating directly with Requests' `auth` parameter.
27+
* Added `SigV4Signer` for integrating with the AIOHTTP request workflow.
28+
* Added `SigV4Curl` for generating signed curl commands.

packages/aws-sdk-signers/CHANGES.md

Lines changed: 0 additions & 40 deletions
This file was deleted.

packages/aws-sdk-signers/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ classifiers = [
2727
]
2828

2929
[project.urls]
30-
"Changelog" = "https://github.com/smithy-lang/smithy-python/blob/develop/packages/aws-sdk-signers/CHANGES.md"
30+
"Changelog" = "https://github.com/smithy-lang/smithy-python/blob/develop/packages/aws-sdk-signers/CHANGELOG.md"
3131
"Code" = "https://github.com/smithy-lang/smithy-python/blob/develop/packages/aws-sdk-signers/"
3232
"Issue tracker" = "https://github.com/smithy-lang/smithy-python/issues"
3333

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
{
2+
"changes": [
3+
{
4+
"type": "feature",
5+
"description": "Added support for Instance Metadata Service (IMDS) credential resolution."
6+
},
7+
{
8+
"type": "feature",
9+
"description": "Added basic endpoint support."
10+
},
11+
{
12+
"type": "feature",
13+
"description": "Added basic User Agent support."
14+
},
15+
{
16+
"type": "feature",
17+
"description": "Added basic AWS specific protocol support for RestJson1 and HTTP bindings."
18+
}
19+
]
20+
}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"changes": [
3+
{
4+
"type": "feature",
5+
"description": "Added support for Container credential resolution, commonly used with ECS/EKS."
6+
}
7+
]
8+
}

0 commit comments

Comments
 (0)