Prepare for v1.7.0 (#241)

ansible-collections · Jun 26, 2021 · 72e055e · 72e055e
1 parent efd651f
commit 72e055e
Show file tree

Hide file tree

Showing 8 changed files with 240 additions and 83 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,13 +5,46 @@ Ansible Windows Release Notes
 .. contents:: Topics
 
 
-v1.6.0
+v1.7.0
 ======
 
 Release Summary
 ---------------
 
-- Release summary for v1.6.0
+- Release summary for v1.7.0
+
+Minor Changes
+-------------
+
+- win_updates - Added ``accept_list`` and ``reject_list`` to replace ``whitelist`` and ``blacklist``
+- win_updates - Added ``failure_msg`` result to the return value of each update that gives a human readable error message if the update failed to download or install
+- win_updates - Added ``filtered_reasons`` that list all the reasons why the update has been filtered - https://github.com/ansible-collections/ansible.windows/issues/226
+- win_updates - Added progress logs to display on higher verbosities the download and install progress for each host
+- win_updates - Added the ``downloaded`` result to the return value of each update to indicate if an update was downloaded or not
+- win_updates - Added the category ``*`` that matches all categories
+- win_updates - Improve Windows Update HRESULT error messages
+- win_updates - Improve the details present in the ``log_path`` log entries for better monitoring
+
+Deprecated Features
+-------------------
+
+- win_updates - Deprecated the ``filtered_reason`` return value for each filtered up in favour of ``filtered_reasons``. This has been done to show all the reasons why an update was filtered and not just the first reason.
+- win_updates - Deprecated the ``use_scheduled_task`` option as it is no longer used.
+- win_updates - Deprecated the ``whitelist`` and ``blacklist`` options in favour of ``accept_list`` and ``reject_list`` respectively to conform to the new standards used in Ansible for these types of options.
+
+Bugfixes
+--------
+
+- win_reboot - Handle connection failures when getting the first boot time command
+- win_updates - Always return the ``failed_updates_count`` on a standard failure - https://github.com/ansible-collections/ansible.windows/issues/13
+- win_updates - Always use a scheduled task which should be less prone to random token errors when trying to connect to Windows Update - https://github.com/ansible-collections/ansible.windows/issues/193
+- win_updates - Attempt a reboot once when ``reboot=True`` is set and a failure occurred - https://github.com/ansible-collections/ansible.windows/issues/22
+- win_updates - Improve the reboot detection behaviour when ``reboot=True`` is set - https://github.com/ansible-collections/ansible.windows/issues/25
+- win_updates - Improve the reboot mechanism - https://github.com/ansible-collections/ansible.windows/issues/143
+- win_updates - Reboot the host when ``reboot=True`` if the first search result indicates a reboot is required - https://github.com/ansible-collections/ansible.windows/issues/49
+
+v1.6.0
+======
 
 Minor Changes
 -------------

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -108,14 +108,14 @@ releases:
   1.0.0:
     changes:
       breaking_changes:
-      - "win_find - module has been refactored to better match the behaviour of the\
-        \ ``find`` module. Here is what has changed:\n  * When the directory specified\
-        \ by ``paths`` does not exist or is a file, it will no longer fail and will\
-        \ just warn the user\n  * Junction points are no longer reported as ``islnk``,\
-        \ use ``isjunction`` to properly report these files. This behaviour matches\
-        \ the win_stat module\n  * Directories no longer return a ``size``, this matches\
-        \ the ``stat`` and ``find`` behaviour and has been removed due to the difficulties\
-        \ in correctly reporting the size of a directory\n"
+      - "win_find - module has been refactored to better match the behaviour of the
+        ``find`` module. Here is what has changed:\n  * When the directory specified
+        by ``paths`` does not exist or is a file, it will no longer fail and will
+        just warn the user\n  * Junction points are no longer reported as ``islnk``,
+        use ``isjunction`` to properly report these files. This behaviour matches
+        the win_stat module\n  * Directories no longer return a ``size``, this matches
+        the ``stat`` and ``find`` behaviour and has been removed due to the difficulties
+        in correctly reporting the size of a directory\n"
       - win_user - Change idempotency checks for ``description`` to be case sensitive
       - win_user - Change idempotency checks for ``fullname`` to be case sensitive
       deprecated_features:
@@ -256,8 +256,6 @@ releases:
         for more services to start up before the plugin finished. This should better
         handle waiting until the logon screen appears rather than just when WinRM
         is first online.
-      release_summary:
-      - Release summary for v1.6.0
       removed_features:
       - win_reboot - Removed ``shutdown_timeout`` and ``shutdown_timeout_sec`` which
         has not done anything since Ansible 2.5.
@@ -266,3 +264,50 @@ releases:
     - win_certificate_store-ca.yml
     - win_reboot-refactor.yml
     release_date: '2021-05-15'
+  1.7.0:
+    changes:
+      bugfixes:
+      - win_reboot - Handle connection failures when getting the first boot time command
+      - win_updates - Always return the ``failed_updates_count`` on a standard failure
+        - https://github.com/ansible-collections/ansible.windows/issues/13
+      - win_updates - Always use a scheduled task which should be less prone to random
+        token errors when trying to connect to Windows Update - https://github.com/ansible-collections/ansible.windows/issues/193
+      - win_updates - Attempt a reboot once when ``reboot=True`` is set and a failure
+        occurred - https://github.com/ansible-collections/ansible.windows/issues/22
+      - win_updates - Improve the reboot detection behaviour when ``reboot=True``
+        is set - https://github.com/ansible-collections/ansible.windows/issues/25
+      - win_updates - Improve the reboot mechanism - https://github.com/ansible-collections/ansible.windows/issues/143
+      - win_updates - Reboot the host when ``reboot=True`` if the first search result
+        indicates a reboot is required - https://github.com/ansible-collections/ansible.windows/issues/49
+      deprecated_features:
+      - win_updates - Deprecated the ``filtered_reason`` return value for each filtered
+        up in favour of ``filtered_reasons``. This has been done to show all the reasons
+        why an update was filtered and not just the first reason.
+      - win_updates - Deprecated the ``use_scheduled_task`` option as it is no longer
+        used.
+      - win_updates - Deprecated the ``whitelist`` and ``blacklist`` options in favour
+        of ``accept_list`` and ``reject_list`` respectively to conform to the new
+        standards used in Ansible for these types of options.
+      minor_changes:
+      - win_updates - Added ``accept_list`` and ``reject_list`` to replace ``whitelist``
+        and ``blacklist``
+      - win_updates - Added ``failure_msg`` result to the return value of each update
+        that gives a human readable error message if the update failed to download
+        or install
+      - win_updates - Added ``filtered_reasons`` that list all the reasons why the
+        update has been filtered - https://github.com/ansible-collections/ansible.windows/issues/226
+      - win_updates - Added progress logs to display on higher verbosities the download
+        and install progress for each host
+      - win_updates - Added the ``downloaded`` result to the return value of each
+        update to indicate if an update was downloaded or not
+      - win_updates - Added the category ``*`` that matches all categories
+      - win_updates - Improve Windows Update HRESULT error messages
+      - win_updates - Improve the details present in the ``log_path`` log entries
+        for better monitoring
+      release_summary:
+      - Release summary for v1.7.0
+    fragments:
+    - release-summary.yml
+    - win_reboot-flaky-connection.yml
+    - win_updates-refactor.yml
+    release_date: '2021-06-26'
diff --git a/changelogs/fragments/win_reboot-flaky-connection.yml b/changelogs/fragments/win_reboot-flaky-connection.yml
diff --git a/changelogs/fragments/win_updates-refactor.yml b/changelogs/fragments/win_updates-refactor.yml
diff --git a/docs/ansible.windows.win_package_module.rst b/docs/ansible.windows.win_package_module.rst
@@ -51,6 +51,7 @@ Parameters
                         <div>If the package is an MSI do not supply the <code>/qn</code>, <code>/log</code> or <code>/norestart</code> arguments.</div>
                         <div>This is only used for the <code>msi</code>, <code>msp</code>, and <code>registry</code> providers.</div>
                         <div>Can be a list of arguments and the module will escape the arguments as necessary, it is recommended to use a string when dealing with MSI packages due to the unique escaping issues with msiexec.</div>
+                        <div>When using a list of arguments each item in the list is considered to be a single argument. As such, if an argument in the list contains a space then Ansible will quote this to ensure that this is seen by Windows as a single argument. Should this behaviour not be what is required, the argument should be split into two separate list items. See the examples section for more detail.</div>
                 </td>
             </tr>
             <tr>
@@ -674,6 +675,19 @@ Examples
         - /passive
         - /norestart
 
+    - name: Install MSBuild thingy with arguments split to prevent quotes
+      ansible.windows.win_package:
+        path: https://download.visualstudio.microsoft.com/download/pr/9665567e-f580-4acd-85f2-bc94a1db745f/vs_BuildTools.exe
+        product_id: '{D1437F51-786A-4F57-A99C-F8E94FBA1BD8}'
+        arguments:
+        - --norestart
+        - --passive
+        - --wait
+        - --add
+        - Microsoft.Net.Component.4.6.1.TargetingPack
+        - --add
+        - Microsoft.Net.Component.4.6.TargetingPack
+
     - name: Install Remote Desktop Connection Manager from msi with a permanent log
       ansible.windows.win_package:
         path: https://download.microsoft.com/download/A/F/0/AF0071F3-B198-4A35-AA90-C68D103BDCCF/rdcman.msi

diff --git a/docs/ansible.windows.win_service_module.rst b/docs/ansible.windows.win_service_module.rst
@@ -279,7 +279,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>The time in seconds after which the failure action list begings from the start if there are no failures.</div>
+                        <div>The time in seconds after which the failure action list resets back to the start of the list if there are no failures.</div>
                         <div>To set this value, <em>failure_actions</em> must have at least 1 action present.</div>
                         <div>Specify <code>&#x27;0xFFFFFFFF&#x27;</code> to set an infinite reset period.</div>
                         <div style="font-size: small; color: darkgreen"><br/>aliases: failure_reset_period</div>