diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c9f8bd55..2980a350 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -5,6 +5,32 @@ Docker Community Collection Release Notes .. contents:: Topics +v2.0.0 +====== + +Release Summary +--------------- + +New major release with some deprecations removed and a breaking change in the ``docker_compose`` module regarding the ``timeout`` parameter. + +Breaking Changes / Porting Guide +-------------------------------- + +- docker_compose - fixed ``timeout`` defaulting behavior so that ``stop_grace_period``, if defined in the compose file, will be used if `timeout`` is not specified (https://github.com/ansible-collections/community.docker/pull/163). + +Deprecated Features +------------------- + +- docker_container - using the special value ``all`` in ``published_ports`` has been deprecated. Use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/210). + +Removed Features (previously deprecated) +---------------------------------------- + +- docker_container - the default value of ``container_default_behavior`` changed to ``no_defaults`` (https://github.com/ansible-collections/community.docker/pull/210). +- docker_container - the default value of ``network_mode`` is now the name of the first network specified in ``networks`` if such are specified and ``networks_cli_compatible=true`` (https://github.com/ansible-collections/community.docker/pull/210). +- docker_container - the special value ``all`` can no longer be used in ``published_ports`` next to other values. Please use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/210). +- docker_login - removed the ``email`` option (https://github.com/ansible-collections/community.docker/pull/210). + v1.10.0 ======= diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml index df35aece..a6d42b11 100644 --- a/changelogs/changelog.yaml +++ b/changelogs/changelog.yaml @@ -432,3 +432,28 @@ releases: - 1.9.1.yml - 192-docker_compose-profiles-idempotency-fix.yml release_date: '2021-08-29' + 2.0.0: + changes: + breaking_changes: + - docker_compose - fixed ``timeout`` defaulting behavior so that ``stop_grace_period``, + if defined in the compose file, will be used if `timeout`` is not specified + (https://github.com/ansible-collections/community.docker/pull/163). + deprecated_features: + - docker_container - using the special value ``all`` in ``published_ports`` + has been deprecated. Use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/210). + release_summary: New major release with some deprecations removed and a breaking + change in the ``docker_compose`` module regarding the ``timeout`` parameter. + removed_features: + - docker_container - the default value of ``container_default_behavior`` changed + to ``no_defaults`` (https://github.com/ansible-collections/community.docker/pull/210). + - docker_container - the default value of ``network_mode`` is now the name of + the first network specified in ``networks`` if such are specified and ``networks_cli_compatible=true`` + (https://github.com/ansible-collections/community.docker/pull/210). + - docker_container - the special value ``all`` can no longer be used in ``published_ports`` + next to other values. Please use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/210). + - docker_login - removed the ``email`` option (https://github.com/ansible-collections/community.docker/pull/210). + fragments: + - 163-docker_compose-timeout-fix.yml + - 2.0.0.yml + - 210-deprecations.yml + release_date: '2021-10-21' diff --git a/changelogs/fragments/163-docker_compose-timeout-fix.yml b/changelogs/fragments/163-docker_compose-timeout-fix.yml deleted file mode 100644 index 492185d9..00000000 --- a/changelogs/fragments/163-docker_compose-timeout-fix.yml +++ /dev/null @@ -1,4 +0,0 @@ ---- -breaking_changes: - - docker_compose - fixed ``timeout`` defaulting behavior so that ``stop_grace_period``, if defined in the compose - file, will be used if `timeout`` is not specified (https://github.com/ansible-collections/community.docker/pull/163). diff --git a/changelogs/fragments/2.0.0.yml b/changelogs/fragments/2.0.0.yml deleted file mode 100644 index bd28ac22..00000000 --- a/changelogs/fragments/2.0.0.yml +++ /dev/null @@ -1 +0,0 @@ -release_summary: New major release with some deprecations removed and a breaking change in the ``docker_compose`` module regarding the ``timeout`` parameter. diff --git a/changelogs/fragments/210-deprecations.yml b/changelogs/fragments/210-deprecations.yml deleted file mode 100644 index 6f8a97c0..00000000 --- a/changelogs/fragments/210-deprecations.yml +++ /dev/null @@ -1,7 +0,0 @@ -removed_features: - - "docker_container - the default value of ``container_default_behavior`` changed to ``no_defaults`` (https://github.com/ansible-collections/community.docker/pull/210)." - - "docker_container - the special value ``all`` can no longer be used in ``published_ports`` next to other values. Please use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/210)." - - "docker_container - the default value of ``network_mode`` is now the name of the first network specified in ``networks`` if such are specified and ``networks_cli_compatible=true`` (https://github.com/ansible-collections/community.docker/pull/210)." - - "docker_login - removed the ``email`` option (https://github.com/ansible-collections/community.docker/pull/210)." -deprecated_features: - - "docker_container - using the special value ``all`` in ``published_ports`` has been deprecated. Use ``publish_all_ports=true`` instead (https://github.com/ansible-collections/community.docker/pull/210)."