Skip to content

Commit

Permalink
Prepare for v1.6.0 release (#221)
Browse files Browse the repository at this point in the history
  • Loading branch information
jborean93 authored May 15, 2021
1 parent a21cdc7 commit 12659f2
Show file tree
Hide file tree
Showing 6 changed files with 73 additions and 43 deletions.
30 changes: 28 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,39 @@ Ansible Windows Release Notes
.. contents:: Topics


v1.5.0
v1.6.0
======

Release Summary
---------------

- Release summary for v1.5.0
- Release summary for v1.6.0

Minor Changes
-------------

- win_reboot - Change the default ``test_command`` run after a reboot to wait 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.

Deprecated Features
-------------------

- win_reboot - Unreachable hosts can be ignored with ``ignore_errors: True``, this ability will be removed in a future version. Use ``ignore_unreachable: True`` to ignore unreachable hosts instead. - https://github.com/ansible-collections/ansible.windows/issues/62

Removed Features (previously deprecated)
----------------------------------------

- win_reboot - Removed ``shutdown_timeout`` and ``shutdown_timeout_sec`` which has not done anything since Ansible 2.5.

Bugfixes
--------

- win_certificate_store - Make sure `store_name: CertificateAuthority` refers to the `CA` store for backwards compatibility - https://github.com/ansible-collections/ansible.windows/pull/216
- win_reboot - Ensure documented return values are always returned even on a failure
- win_reboot - Handle more connection failures during the reboot phases
- win_reboot - User defined commands are run wrapped as a PowerShell command so they work on all shells - https://github.com/ansible-collections/ansible.windows/issues/36

v1.5.0
======

Minor Changes
-------------
Expand Down
47 changes: 37 additions & 10 deletions changelogs/changelog.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -226,8 +226,6 @@ releases:
- win_certificate_store - Added functionality to open the store for a service
account using ``store_type=service store_location=<service name>``
- win_user - Support specifying groups using the SecurityIdentifier - https://github.com/ansible-collections/ansible.windows/issues/153
release_summary:
- Release summary for v1.5.0
fragments:
- release_150.yml
- setup-epoch.yml
Expand All @@ -239,3 +237,32 @@ releases:
name: win_powershell
namespace: ''
release_date: '2021-04-13'
1.6.0:
changes:
bugfixes:
- 'win_certificate_store - Make sure `store_name: CertificateAuthority` refers
to the `CA` store for backwards compatibility - https://github.com/ansible-collections/ansible.windows/pull/216'
- win_reboot - Ensure documented return values are always returned even on a
failure
- win_reboot - Handle more connection failures during the reboot phases
- win_reboot - User defined commands are run wrapped as a PowerShell command
so they work on all shells - https://github.com/ansible-collections/ansible.windows/issues/36
deprecated_features:
- 'win_reboot - Unreachable hosts can be ignored with ``ignore_errors: True``,
this ability will be removed in a future version. Use ``ignore_unreachable:
True`` to ignore unreachable hosts instead. - https://github.com/ansible-collections/ansible.windows/issues/62'
minor_changes:
- win_reboot - Change the default ``test_command`` run after a reboot to wait
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.
fragments:
- release_summary.yml
- win_certificate_store-ca.yml
- win_reboot-refactor.yml
release_date: '2021-05-15'
4 changes: 0 additions & 4 deletions changelogs/fragments/win_certificate_store-ca.yml

This file was deleted.

18 changes: 0 additions & 18 deletions changelogs/fragments/win_reboot-refactor.yml

This file was deleted.

15 changes: 7 additions & 8 deletions docs/ansible.windows.win_reboot_module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Parameters
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"(Get-WmiObject -ClassName Win32_OperatingSystem).LastBootUpTime"</div>
<b>Default:</b><br/><div style="color: blue">"(Get-CimInstance -ClassName Win32_OperatingSystem -Property LastBootUpTime).LastBootUpTime.ToFileTime()"</div>
</td>
<td>
<div>Command to run that returns a unique string indicating the last time the system was booted.</div>
Expand All @@ -56,7 +56,7 @@ Parameters
<b>connect_timeout</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
<span style="color: purple">float</span>
</div>
</td>
<td>
Expand Down Expand Up @@ -89,7 +89,7 @@ Parameters
<b>post_reboot_delay</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
<span style="color: purple">float</span>
</div>
</td>
<td>
Expand All @@ -107,7 +107,7 @@ Parameters
<b>pre_reboot_delay</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
<span style="color: purple">float</span>
</div>
</td>
<td>
Expand All @@ -124,7 +124,7 @@ Parameters
<b>reboot_timeout</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
<span style="color: purple">float</span>
</div>
</td>
<td>
Expand All @@ -146,10 +146,10 @@ Parameters
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"whoami"</div>
</td>
<td>
<div>Command to expect success for to determine the machine is ready for management.</div>
<div>By default this test command is a custom one to detect when the Windows Logon screen is up and ready to accept credentials. Using a custom command will replace this behaviour and just run the command specified.</div>
</td>
</tr>
</table>
Expand All @@ -161,7 +161,7 @@ Notes

.. note::
- If a shutdown was already scheduled on the system, :ref:`ansible.windows.win_reboot <ansible.windows.win_reboot_module>` will abort the scheduled shutdown and enforce its own shutdown.
- Beware that when :ref:`ansible.windows.win_reboot <ansible.windows.win_reboot_module>` returns, 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.
- Beware that when :ref:`ansible.windows.win_reboot <ansible.windows.win_reboot_module>` returns, 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. This has been slightly mitigated in the ``1.6.0`` release of ``ansible.windows`` but it is not guranteed to always wait until the logon prompt is shown.
- The connection user must have the ``SeRemoteShutdownPrivilege`` privilege enabled, see https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/force-shutdown-from-a-remote-system for more information.


Expand Down Expand Up @@ -202,7 +202,6 @@ Examples
name: WinRM
start_mode: delayed
# Additionally, you can add a delay before running the next task
- name: Reboot a machine that takes time to settle after being booted
ansible.windows.win_reboot:
Expand Down
2 changes: 1 addition & 1 deletion galaxy.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
namespace: ansible
name: windows
version: 1.5.0
version: 1.6.0
readme: README.md
authors:
- Jordan Borean @jborean93
Expand Down

0 comments on commit 12659f2

Please sign in to comment.