Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 0483cf6

Browse files
authoredSep 22, 2022
Add rendered Changelog to the docs site (ansible-collections#1512)
SUMMARY Add rendered Changelog to the docs site ISSUE TYPE - Docs Pull Request COMPONENT NAME README.md docs/docsite/extra-docs.yml docs/docsite/rst/CHANGELOG.rst ADDITIONAL INFORMATION Related to ansible-community/community-team#61
1 parent 93fe6a9 commit 0483cf6

File tree

6 files changed

+22
-15
lines changed

6 files changed

+22
-15
lines changed
 

‎CHANGELOG.rst

+7-7
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Minor Changes
3535
- ec2_launch_template - Adds support for specifying the ``source_version`` upon which template updates are based (https://github.com/ansible-collections/community.aws/pull/239).
3636
- ec2_scaling_policy - add TargetTrackingScaling as a scaling policy option (https://github.com/ansible-collections/community.aws/pull/771)
3737
- ec2_vpc_vgw_info - updated to not throw an error when run in check_mode (https://github.com/ansible-collections/community.aws/issues/137).
38-
- ecs_ecr - add `force_absent` parameter for removing repositories that contain images (https://github.com/ansible-collections/community.aws/pull/1316).
38+
- ecs_ecr - add ``force_absent`` parameter for removing repositories that contain images (https://github.com/ansible-collections/community.aws/pull/1316).
3939
- ecs_service - add ``wait`` parameter and waiter for deleting services (https://github.com/ansible-collections/community.aws/pull/1209).
4040
- ecs_service - added ``tags`` and ``tag_propagation`` support to the module (https://github.com/ansible-collections/community.aws/pull/543).
4141
- ecs_service - added parameter ``deployment_controller`` so service can be controlled by Code Deploy (https://github.com/ansible-collections/community.aws/pull/340).
@@ -67,7 +67,7 @@ Bugfixes
6767
--------
6868

6969
- aws_api_gateway_domain - added the ``aws_api_gateway_domain`` module to the aws module_defaults group (https://github.com/ansible-collections/community.aws/pull/1283).
70-
- aws_config_aggregator - Fix `KeyError` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
70+
- aws_config_aggregator - Fix ``KeyError`` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
7171
- aws_config_aggregator - Fix idempotency when ``account_sources`` parameter is not specified (https://github.com/ansible-collections/community.aws/pull/645).
7272
- aws_ssm - pull S3 bucket region for session generated for file transfer during playbooks (https://github.com/ansible-collections/community.aws/issues/1190).
7373
- aws_ssm_parameter_store - fixed bug where module wasn't consistently idempotent (https://github.com/ansible-collections/community.aws/pull/1309).
@@ -158,13 +158,13 @@ Minor Changes
158158
- iam_role - delete inline policies prior to deleting role (https://github.com/ansible-collections/community.aws/pull/1054).
159159
- iam_role - remove global vars and refactor accordingly (https://github.com/ansible-collections/community.aws/pull/1054).
160160
- iam_user - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
161-
- iam_user - add `user` value to return data structure to deprecate old `iam_user` (https://github.com/ansible-collections/community.aws/pull/1059).
161+
- iam_user - add ``user`` value to return data structure to deprecate old ``iam_user`` (https://github.com/ansible-collections/community.aws/pull/1059).
162162
- lambda - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1202).
163163
- lambda - add kms_key_arn parameter (https://github.com/ansible-collections/community.aws/pull/1108).
164164
- lambda - the behavior for ``tags`` has been updated, to remove all tags the ``tags`` parameter must be explicitly set to the empty dict ``{}`` and ``purge_tags`` to ``True`` (https://github.com/ansible-collections/community.aws/pull/1202).
165165
- rds_cluster - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
166166
- rds_instance - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1182).
167-
- rds_instance - add `deletion_protection` parameter (https://github.com/ansible-collections/community.aws/pull/1105).
167+
- rds_instance - add ``deletion_protection`` parameter (https://github.com/ansible-collections/community.aws/pull/1105).
168168
- rds_instance - add support for addition/removal of iam roles to db instance (https://github.com/ansible-collections/community.aws/pull/1002).
169169
- rds_instance_snapshot - ``resource_tags`` has been added as an alias for the ``tags`` parameter (https://github.com/ansible-collections/community.aws/pull/1200).
170170
- rds_instance_snapshot - add ``check_mode`` (https://github.com/ansible-collections/community.aws/pull/789).
@@ -238,7 +238,7 @@ Bugfixes
238238

239239
- aws_ssm connection plugin - fix linting errors in documentation data (https://github.com/ansible-collections/community.aws/pull/965).
240240
- aws_ssm_parameter_store - fix exception when description was set without value (https://github.com/ansible-collections/community.aws/pull/1241).
241-
- don't require `db_instance_identifier` on state = present (https://github.com/ansible-collections/community.aws/pull/1078).
241+
- don't require ``db_instance_identifier`` on state = present (https://github.com/ansible-collections/community.aws/pull/1078).
242242
- dynamodb_table - fix an issue when creating secondary indexes with global_keys_only (https://github.com/ansible-collections/community.aws/issues/967).
243243
- ec2_asg - Change the default value of ``purge_tags`` to ``false``. Restores previous behaviour (https://github.com/ansible-collections/community.aws/pull/1064).
244244
- ec2_vpc_vpn - fix exception when no tags are passed in check mode (https://github.com/ansible-collections/community.aws/pull/1242).
@@ -250,7 +250,7 @@ Bugfixes
250250
- elb_target_group_info - Up default value AWS backoff retries for paginated calls. (https://github.com/ansible-collections/community.aws/pull/1113).
251251
- execute_lamba - add waiter for function_updated (https://github.com/ansible-collections/community.aws/pull/1108).
252252
- execute_lambda - fix check mode and update RETURN documentation (https://github.com/ansible-collections/community.aws/pull/1115).
253-
- iam_policy - require one of `policy_document` and `policy_json` when state is present to prevent MalformedPolicyDocumentException from being thrown (https://github.com/ansible-collections/community.aws/pull/1093).
253+
- iam_policy - require one of ``policy_document`` and ``policy_json`` when state is present to prevent MalformedPolicyDocumentException from being thrown (https://github.com/ansible-collections/community.aws/pull/1093).
254254
- iam_user - don't delete user login profile on check mode (https://github.com/ansible-collections/community.aws/pull/1059).
255255
- iam_user_info - gracefully handle when no users are found (https://github.com/ansible-collections/community.aws/pull/1059).
256256
- lambda - fix bug where tag keys were mangled in the return values (https://github.com/ansible-collections/community.aws/pull/1202).
@@ -293,7 +293,7 @@ Bugfixes
293293
--------
294294

295295
- aws_api_gateway_domain - added the ``aws_api_gateway_domain`` module to the aws module_defaults group (https://github.com/ansible-collections/community.aws/pull/1283).
296-
- aws_config_aggregator - Fix `KeyError` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
296+
- aws_config_aggregator - Fix ``KeyError`` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
297297
- aws_config_aggregator - Fix idempotency when ``account_sources`` parameter is not specified (https://github.com/ansible-collections/community.aws/pull/645).
298298
- aws_ssm - pull S3 bucket region for session generated for file transfer during playbooks (https://github.com/ansible-collections/community.aws/issues/1190).
299299
- cloudfront_response_headers_policy - added the ``cloudfront_response_headers_policy`` module to the aws module_defaults group (https://github.com/ansible-collections/community.aws/pull/1283).

‎README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ You can also join us on:
114114
- [Getting Started With AWS Ansible Module Development and Community Contribution](https://www.ansible.com/blog/getting-started-with-aws-ansible-module-development)
115115

116116
## Release notes
117-
<!--Add a link to a changelog.rst file or an external docsite to cover this information. -->
117+
118+
See the [rendered changelog](https://ansible-collections.github.io/community.aws/branch/main/collections/community/aws/docsite/CHANGELOG.html) or the [raw generated changelog](https://github.com/ansible-collections/community.aws/tree/main/CHANGELOG.rst).
118119

119120
## Roadmap
120121

‎changelogs/changelog.yaml

+7-7
Original file line numberDiff line numberDiff line change
@@ -2029,7 +2029,7 @@ releases:
20292029
bugfixes:
20302030
- aws_api_gateway_domain - added the ``aws_api_gateway_domain`` module to the
20312031
aws module_defaults group (https://github.com/ansible-collections/community.aws/pull/1283).
2032-
- aws_config_aggregator - Fix `KeyError` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
2032+
- aws_config_aggregator - Fix ``KeyError`` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
20332033
- aws_config_aggregator - Fix idempotency when ``account_sources`` parameter
20342034
is not specified (https://github.com/ansible-collections/community.aws/pull/645).
20352035
- aws_ssm - pull S3 bucket region for session generated for file transfer during
@@ -2093,7 +2093,7 @@ releases:
20932093
- aws_ssm connection plugin - fix linting errors in documentation data (https://github.com/ansible-collections/community.aws/pull/965).
20942094
- aws_ssm_parameter_store - fix exception when description was set without value
20952095
(https://github.com/ansible-collections/community.aws/pull/1241).
2096-
- don't require `db_instance_identifier` on state = present (https://github.com/ansible-collections/community.aws/pull/1078).
2096+
- don't require ``db_instance_identifier`` on state = present (https://github.com/ansible-collections/community.aws/pull/1078).
20972097
- dynamodb_table - fix an issue when creating secondary indexes with global_keys_only
20982098
(https://github.com/ansible-collections/community.aws/issues/967).
20992099
- ec2_asg - Change the default value of ``purge_tags`` to ``false``. Restores
@@ -2113,7 +2113,7 @@ releases:
21132113
calls. (https://github.com/ansible-collections/community.aws/pull/1113).
21142114
- execute_lamba - add waiter for function_updated (https://github.com/ansible-collections/community.aws/pull/1108).
21152115
- execute_lambda - fix check mode and update RETURN documentation (https://github.com/ansible-collections/community.aws/pull/1115).
2116-
- iam_policy - require one of `policy_document` and `policy_json` when state
2116+
- iam_policy - require one of ``policy_document`` and ``policy_json`` when state
21172117
is present to prevent MalformedPolicyDocumentException from being thrown (https://github.com/ansible-collections/community.aws/pull/1093).
21182118
- iam_user - don't delete user login profile on check mode (https://github.com/ansible-collections/community.aws/pull/1059).
21192119
- iam_user_info - gracefully handle when no users are found (https://github.com/ansible-collections/community.aws/pull/1059).
@@ -2268,7 +2268,7 @@ releases:
22682268
- iam_role - remove global vars and refactor accordingly (https://github.com/ansible-collections/community.aws/pull/1054).
22692269
- iam_user - ``resource_tags`` has been added as an alias for the ``tags`` parameter
22702270
(https://github.com/ansible-collections/community.aws/pull/1182).
2271-
- iam_user - add `user` value to return data structure to deprecate old `iam_user`
2271+
- iam_user - add ``user`` value to return data structure to deprecate old ``iam_user``
22722272
(https://github.com/ansible-collections/community.aws/pull/1059).
22732273
- lambda - ``resource_tags`` has been added as an alias for the ``tags`` parameter
22742274
(https://github.com/ansible-collections/community.aws/pull/1202).
@@ -2280,7 +2280,7 @@ releases:
22802280
parameter (https://github.com/ansible-collections/community.aws/pull/1182).
22812281
- rds_instance - ``resource_tags`` has been added as an alias for the ``tags``
22822282
parameter (https://github.com/ansible-collections/community.aws/pull/1182).
2283-
- rds_instance - add `deletion_protection` parameter (https://github.com/ansible-collections/community.aws/pull/1105).
2283+
- rds_instance - add ``deletion_protection`` parameter (https://github.com/ansible-collections/community.aws/pull/1105).
22842284
- rds_instance - add support for addition/removal of iam roles to db instance
22852285
(https://github.com/ansible-collections/community.aws/pull/1002).
22862286
- rds_instance_snapshot - ``resource_tags`` has been added as an alias for the
@@ -2450,7 +2450,7 @@ releases:
24502450
bugfixes:
24512451
- aws_api_gateway_domain - added the ``aws_api_gateway_domain`` module to the
24522452
aws module_defaults group (https://github.com/ansible-collections/community.aws/pull/1283).
2453-
- aws_config_aggregator - Fix `KeyError` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
2453+
- aws_config_aggregator - Fix ``KeyError`` when updating existing aggregator (https://github.com/ansible-collections/community.aws/pull/645).
24542454
- aws_config_aggregator - Fix idempotency when ``account_sources`` parameter
24552455
is not specified (https://github.com/ansible-collections/community.aws/pull/645).
24562456
- aws_ssm - pull S3 bucket region for session generated for file transfer during
@@ -2498,7 +2498,7 @@ releases:
24982498
- ec2_scaling_policy - add TargetTrackingScaling as a scaling policy option
24992499
(https://github.com/ansible-collections/community.aws/pull/771)
25002500
- ec2_vpc_vgw_info - updated to not throw an error when run in check_mode (https://github.com/ansible-collections/community.aws/issues/137).
2501-
- ecs_ecr - add `force_absent` parameter for removing repositories that contain
2501+
- ecs_ecr - add ``force_absent`` parameter for removing repositories that contain
25022502
images (https://github.com/ansible-collections/community.aws/pull/1316).
25032503
- ecs_service - add ``wait`` parameter and waiter for deleting services (https://github.com/ansible-collections/community.aws/pull/1209).
25042504
- ecs_service - added ``tags`` and ``tag_propagation`` support to the module

‎docs/docsite/extra-docs.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sections:
3+
- title: Changelog
4+
toctree:
5+
- CHANGELOG

‎docs/docsite/rst/CHANGELOG.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../CHANGELOG.rst

0 commit comments

Comments
 (0)