Prepare for v1.9.0 release (#323)

ansible-collections · Dec 20, 2021 · 4c6cedd · 4c6cedd
1 parent 877fb14
commit 4c6cedd
Show file tree

Hide file tree

Showing 15 changed files with 85 additions and 31 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,13 +5,33 @@ Ansible Windows Release Notes
 .. contents:: Topics
 
 
-v1.8.0
+v1.9.0
 ======
 
 Release Summary
 ---------------
 
-- Release summary for v1.8.0
+- Release summary for v1.9.0
+
+Minor Changes
+-------------
+
+- win_dsc - deduplicated error writing code with a new function. No actual error text was changed.
+- win_powershell - Added ``$Ansible.Verbosity`` for scripts to adjust code based on the verbosity Ansible is running as
+
+Bugfixes
+--------
+
+- win_command - Use the 24 hour format for the hours of ``start`` and ``end`` - https://github.com/ansible-collections/ansible.windows/issues/303
+- win_copy - improve dest folder size detection to handle broken and recursive symlinks as well as inaccesible folders - https://github.com/ansible-collections/ansible.windows/issues/298
+- win_dsc - Provide better error message when trying to invoke a composite DSC resource
+- win_shell - Use the 24 hour format for the hours of ``start`` and ``end`` - https://github.com/ansible-collections/ansible.windows/issues/303
+- win_updates - Fix return value for ``updates`` and ``filtered_updates`` to match original stucture - https://github.com/ansible-collections/ansible.windows/issues/307
+- win_updates - Fixed issue when attempting to run ``task.ps1`` with a host that has a restrictive execution policy set through GPO
+- win_updates - prevent the host from going to sleep if a low sleep timeout is set - https://github.com/ansible-collections/ansible.windows/issues/310
+
+v1.8.0
+======
 
 Minor Changes
 -------------

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -367,8 +367,6 @@ releases:
       - win_whoami - Fix conflicts with existing ``LIB`` environment variable
       minor_changes:
       - win_updates - Added the ``skip_optional`` module option to skip optional updates
-      release_summary:
-      - Release summary for v1.8.0
     fragments:
     - 283-win_dns_client_IPv6_DNS.yml
     - 290-win_user-state-query.yml
@@ -378,3 +376,38 @@ releases:
     - win_copy-dst-size.yml
     - win_updates-skip-optional.yml
     release_date: '2021-11-03'
+  1.9.0:
+    changes:
+      bugfixes:
+      - win_command - Use the 24 hour format for the hours of ``start`` and ``end``
+        - https://github.com/ansible-collections/ansible.windows/issues/303
+      - win_copy - improve dest folder size detection to handle broken and recursive
+        symlinks as well as inaccesible folders - https://github.com/ansible-collections/ansible.windows/issues/298
+      - win_dsc - Provide better error message when trying to invoke a composite DSC
+        resource
+      - win_shell - Use the 24 hour format for the hours of ``start`` and ``end``
+        - https://github.com/ansible-collections/ansible.windows/issues/303
+      - win_updates - Fix return value for ``updates`` and ``filtered_updates`` to
+        match original stucture - https://github.com/ansible-collections/ansible.windows/issues/307
+      - win_updates - Fixed issue when attempting to run ``task.ps1`` with a host
+        that has a restrictive execution policy set through GPO
+      - win_updates - prevent the host from going to sleep if a low sleep timeout
+        is set - https://github.com/ansible-collections/ansible.windows/issues/310
+      minor_changes:
+      - win_dsc - deduplicated error writing code with a new function. No actual error
+        text was changed.
+      - win_powershell - Added ``$Ansible.Verbosity`` for scripts to adjust code based
+        on the verbosity Ansible is running as
+      release_summary:
+      - Release summary for v1.9.0
+    fragments:
+    - release-1.9.0.yml
+    - win_command-shell-time.yml
+    - win_copy-dest-calc-fix.yml
+    - win_dsc-composite-resource-error.yml
+    - win_dsc-write-error-standardize.yml
+    - win_powershell.yml
+    - win_updates-execution-policy.yml
+    - win_updates-return.yml
+    - win_updates-sleep.yml
+    release_date: '2021-12-21'
diff --git a/changelogs/fragments/win_command-shell-time.yml b/changelogs/fragments/win_command-shell-time.yml
diff --git a/changelogs/fragments/win_copy-dest-calc-fix.yml b/changelogs/fragments/win_copy-dest-calc-fix.yml
diff --git a/changelogs/fragments/win_dsc-composite-resource-error.yml b/changelogs/fragments/win_dsc-composite-resource-error.yml
diff --git a/changelogs/fragments/win_dsc-write-error-standardize.yml b/changelogs/fragments/win_dsc-write-error-standardize.yml
diff --git a/changelogs/fragments/win_powershell.yml b/changelogs/fragments/win_powershell.yml
diff --git a/changelogs/fragments/win_updates-execution-policy.yml b/changelogs/fragments/win_updates-execution-policy.yml
diff --git a/changelogs/fragments/win_updates-return.yml b/changelogs/fragments/win_updates-return.yml
diff --git a/changelogs/fragments/win_updates-sleep.yml b/changelogs/fragments/win_updates-sleep.yml
diff --git a/docs/ansible.windows.win_find_module.rst b/docs/ansible.windows.win_find_module.rst
@@ -270,6 +270,12 @@ Parameters
     <br/>
 
 
+Notes
+-----
+
+.. note::
+   - When scanning directories with a large number of files containing lots of data it is recommended to set ``get_checksum=false``. This will speed up the time it takes to scan the folders as getting a checksum needs to read the contents of every file it returns.
+
 
 
 Examples

diff --git a/docs/ansible.windows.win_powershell_module.rst b/docs/ansible.windows.win_powershell_module.rst
@@ -206,6 +206,7 @@ Notes
    - ``$Ansible.Changed`` can be set to ``true`` or ``false`` to reflect whether the module made a change or not. By default this is set to ``true``.
    - ``$Ansible.Failed`` can be set to ``true`` if the script wants to return the failure back to the controller.
    - ``$Ansible.Tmpdir`` is the path to a temporary directory to use as a scratch location that is cleaned up after the module has finished.
+   - ``$Ansible.Verbosity`` reveals Ansible's verbosity level for this play. Allows the script to set VerbosePreference/DebugPreference based on verbosity. Added in ``1.9.0``.
    - Any host/console output like ``Write-Host`` or ``[Console]::WriteLine`` is not considered an output object, they are returned as a string in *host_out* and *host_err*.
    - The module will skip running the script when in check mode unless the script defines ``[CmdletBinding(SupportsShouldProcess``]).
 
@@ -310,6 +311,19 @@ Examples
               $Ansible.Changed = $true
           }
 
+    - name: Define when to enable Verbose/Debug output
+      ansible.windows.win_powershell:
+        script: |
+          if ($Ansible.Verbosity -ge 3) {
+              $VerbosePreference = "Continue"
+          }
+          if ($Ansible.Verbosity -eq 5) {
+              $DebugPreference = "Continue"
+          }
+          Write-Output "Hello World!"
+          Write-Verbose "Hello World!"
+          Write-Debug "Hello World!"
+
 
 
 Return Values

diff --git a/docs/ansible.windows.win_updates_module.rst b/docs/ansible.windows.win_updates_module.rst
@@ -278,7 +278,7 @@ Notes
    - :ref:`ansible.windows.win_updates <ansible.windows.win_updates_module>` can take a significant amount of time to complete (hours, in some cases). Performance depends on many factors, including OS version, number of updates, system load, and update server load.
    - Beware that just after :ref:`ansible.windows.win_updates <ansible.windows.win_updates_module>` reboots the system, the Windows system may not have settled yet and some base services could be in limbo. This can result in unexpected behavior. Check the examples for ways to mitigate this.
    - More information about PowerShell and how it handles RegEx strings can be found at https://technet.microsoft.com/en-us/library/2007.11.powershell.aspx.
-   - The current module doesn't support Systems Center Configuration Manager (SCCM). See L(https://github.com/ansible-collections/ansible.windows/issues/194)
+   - The current module doesn't support Systems Center Configuration Manager (SCCM). See https://github.com/ansible-collections/ansible.windows/issues/194
 
 
 See Also
@@ -388,12 +388,12 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                     <b>filtered_updates</b>
                     <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
                     <div style="font-size: small">
-                      <span style="color: purple">complex</span>
+                      <span style="color: purple">dictionary</span>
                     </div>
                 </td>
                 <td>success</td>
                 <td>
-                            <div>List of updates that were found but were filtered based on <em>blacklist</em>, <em>whitelist</em> or <em>category_names</em>. The return value is in the same form as <em>updates</em>, along with <em>filtered_reason</em>.</div>
+                            <div>Updates that were found but were filtered based on <em>blacklist</em>, <em>whitelist</em> or <em>category_names</em>. The return value is in the same form as <em>updates</em>, along with <em>filtered_reason</em>.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">see the updates return value</div>
@@ -497,12 +497,13 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                     <b>updates</b>
                     <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
                     <div style="font-size: small">
-                      <span style="color: purple">complex</span>
+                      <span style="color: purple">dictionary</span>
                     </div>
                 </td>
                 <td>success</td>
                 <td>
-                            <div>List of updates that were found/installed.</div>
+                            <div>Updates that were found/installed.</div>
+                            <div>The key for each update is the <code>id</code> of the update.</div>
                     <br/>
                 </td>
             </tr>

diff --git a/docs/ansible.windows.win_user_right_module.rst b/docs/ansible.windows.win_user_right_module.rst
@@ -89,6 +89,7 @@ Parameters
                         <div>A list of users or groups to add/remove on the User Right.</div>
                         <div>These can be in the form DOMAIN\user-group, [email protected] for domain users/groups.</div>
                         <div>For local users/groups it can be in the form user-group, .\user-group, SERVERNAME\user-group where SERVERNAME is the name of the remote server.</div>
+                        <div>It is highly recommended to use the <code>.\</code> or <code>SERVERNAME\</code> prefix to avoid any ambiguity with domain account names or errors trying to lookup an account on a domain controller.</div>
                         <div>You can also add special local accounts like SYSTEM and others.</div>
                         <div>Can be set to an empty list with <em>action=set</em> to remove all accounts from the right.</div>
                 </td>

diff --git a/galaxy.yml b/galaxy.yml
@@ -1,6 +1,6 @@
 namespace: ansible
 name: windows
-version: 1.8.0
+version: 1.9.0
 readme: README.md
 authors:
 - Jordan Borean @jborean93
-Original file line number
+Diff line change
@@ Expand Up / @@ -270,6 +270,12 @@ Parameters @@
         <br/>
+    Notes
+    -----
+    .. note::
+       - When scanning directories with a large number of files containing lots of data it is recommended to set ``get_checksum=false``. This will speed up the time it takes to scan the folders as getting a checksum needs to read the contents of every file it returns.
     Examples
@@ Expand Down @@