Prepare for 0.2.0 release

README.md

@@ -176,17 +176,24 @@ You can run the collection's test suites with the commands:
 
 The current process for publishing new versions of the Windows Community Collection is manual, and requires a user who has access to the `community` namespace on Ansible Galaxy to publish the build artifact.
 
-* Update the CHANGELOG:
-  * Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
+* Update `galaxy.yml` with the new version for the collection.
+* Rebuild the plugin docs:
+    ```bash
+    git clone https://github.com/ansible-network/collection_prep.git /tmp/collection_prep
+    python /tmp/collection_prep/add_docs.py --path ./ --branch-name main
+    rm -rf /tmp/collection_prep
+    ```
+* Update the `CHANGELOG`:
+  * Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed `pip install antsibull-changelog`.
   * Make sure there are fragments for all known changes in `changelogs/fragments`.
+  * Add a new fragment with the header `release_summary` to give a summary on the release.
   * Run `antsibull-changelog release`.
-* Update `galaxy.yml` with the new `version` for the collection.
-* Create a release in GitHub to tag the commit at the version to build.
-* Run the following commands to build and release the new version on Galaxy:
-  ```
-  ansible-galaxy collection build
-  ansible-galaxy collection publish ./community-windows-$VERSION_HERE.tar.gz
-  ```
+* Commit the changes and wait for CI to be green
+* Build and publish the collection to Galaxy:
+    ```bash
+    git clone https://github.com/ansible-collections/community.windows.git /tmp/community.windows
+    ansible-galaxy collection build /tmp/community.windows --output-path /tmp/community.windows
+    ansible-galaxy collection publish $(find /tmp/community.windows -maxdepth 1 -name 'community-windows-*.tar.gz') --token <API_KEY>
 
 After the version is published, verify it exists on the [Windows Community Collection Galaxy page](https://galaxy.ansible.com/community/windows).
 
@@ -205,4 +212,4 @@ For more information about Ansible's Windows integration, join the `#ansible-win
 
 GNU General Public License v3.0 or later
 
-See [COPYING](COPYING) to see the full text.
+See [COPYING](COPYING) to see the full text.

changelogs/CHANGELOG.rst

@@ -0,0 +1,55 @@
+===============================
+Community Windows Release Notes
+===============================
+
+.. contents:: Topics
+
+
+v0.2.0
+======
+
+Release Summary
+---------------
+
+This is the first proper release of the ``community.windows`` collection on 2020-07-18.
+The changelog describes all changes made to the modules and plugins included in this collection since Ansible 2.9.0.
+
+
+Minor Changes
+-------------
+
+- win_disk_facts - Set output array order to be by disk number property - https://github.com/ansible/ansible/issues/63998
+- win_domain_computer - ``sam_account_name`` with missing ``$`` will have it added automatically (https://github.com/ansible-collections/community.windows/pull/93)
+- win_domain_computer - add support for offline domain join (https://github.com/ansible-collections/community.windows/pull/93)
+- win_domain_group_membership - Add multi-domain forest support - https://github.com/ansible/ansible/issues/59829
+- win_domain_user - Added the ``identity`` module option to explicitly set the identity of the user when searching for it - https://github.com/ansible/ansible/issues/45298
+- win_firewall- Change req check from wmf version to cmdlets presence - https://github.com/ansible/ansible/issues/63003
+- win_firewall_rule - add parameter to support ICMP Types and Codes (https://github.com/ansible/ansible/issues/46809)
+- win_iis_webapplication - add new options ``connect_as``, ``username``, ``password``.
+- win_iis_webapplication - now uses the current application pool of the website instead of the DefaultAppPool if none was specified.
+- win_nssm - Implement additional parameters - (https://github.com/ansible/ansible/issues/62620)
+- win_pester - Only execute ``*.tests.ps1`` in ``path`` to match the default behaviour in Pester - https://github.com/ansible/ansible/issues/55736
+
+Removed Features (previously deprecated)
+----------------------------------------
+
+- win_disk_image - removed the deprecated return value ``mount_path`` in favour of ``mount_paths``.
+
+Bugfixes
+--------
+
+- **security issue** win_unzip - normalize paths in archive to ensure extracted files do not escape from the target directory (CVE-2020-1737)
+- psexec - Fix issue where the Kerberos package was not detected as being available.
+- psexec - Fix issue where the ``interactive`` option was not being passed down to the library.
+- win_credential - Fix issue that errors when trying to add a ``name`` with wildcards.
+- win_domain_computer - Fix idempotence checks when ``sAMAccountName`` is different from ``name``
+- win_domain_computer - Honour the explicit domain server and credentials when moving or removing a computer object - https://github.com/ansible/ansible/pull/63093
+- win_domain_user - Better handle cases when getting a new user's groups fail - https://github.com/ansible/ansible/issues/54331
+- win_format - Idem not working if file exist but same fs (https://github.com/ansible/ansible/issues/58302)
+- win_format - fixed issue where module would not change allocation unit size (https://github.com/ansible/ansible/issues/56961)
+- win_iis_webapppool - Do not try and set attributes in check mode when the pool did not exist
+- win_iis_website - Actually restart the site when ``state=restarted`` - https://github.com/ansible/ansible/issues/63828
+- win_partition - Fix invalid variable name causing a failure on checks - https://github.com/ansible/ansible/issues/62401
+- win_partition - don't resize partitions if size difference is < 1 MiB
+- win_timezone - Allow for _dstoff timezones
+- win_unzip - Fix support for paths with square brackets not being detected properly

changelogs/changelog.yaml

@@ -0,0 +1,85 @@
+ancestor: null
+releases:
+  0.2.0:
+    changes:
+      bugfixes:
+      - '**security issue** win_unzip - normalize paths in archive to ensure extracted
+        files do not escape from the target directory (CVE-2020-1737)
+
+        '
+      - psexec - Fix issue where the Kerberos package was not detected as being available.
+      - psexec - Fix issue where the ``interactive`` option was not being passed down
+        to the library.
+      - win_credential - Fix issue that errors when trying to add a ``name`` with
+        wildcards.
+      - win_domain_computer - Fix idempotence checks when ``sAMAccountName`` is different
+        from ``name``
+      - win_domain_computer - Honour the explicit domain server and credentials when
+        moving or removing a computer object - https://github.com/ansible/ansible/pull/63093
+      - win_domain_user - Better handle cases when getting a new user's groups fail
+        - https://github.com/ansible/ansible/issues/54331
+      - win_format - Idem not working if file exist but same fs (https://github.com/ansible/ansible/issues/58302)
+      - win_format - fixed issue where module would not change allocation unit size
+        (https://github.com/ansible/ansible/issues/56961)
+      - win_iis_webapppool - Do not try and set attributes in check mode when the
+        pool did not exist
+      - win_iis_website - Actually restart the site when ``state=restarted`` - https://github.com/ansible/ansible/issues/63828
+      - win_partition - Fix invalid variable name causing a failure on checks - https://github.com/ansible/ansible/issues/62401
+      - win_partition - don't resize partitions if size difference is < 1 MiB
+      - win_timezone - Allow for _dstoff timezones
+      - win_unzip - Fix support for paths with square brackets not being detected
+        properly
+      minor_changes:
+      - win_disk_facts - Set output array order to be by disk number property - https://github.com/ansible/ansible/issues/63998
+      - win_domain_computer - ``sam_account_name`` with missing ``$`` will have it
+        added automatically (https://github.com/ansible-collections/community.windows/pull/93)
+      - win_domain_computer - add support for offline domain join (https://github.com/ansible-collections/community.windows/pull/93)
+      - win_domain_group_membership - Add multi-domain forest support - https://github.com/ansible/ansible/issues/59829
+      - win_domain_user - Added the ``identity`` module option to explicitly set the
+        identity of the user when searching for it - https://github.com/ansible/ansible/issues/45298
+      - win_firewall- Change req check from wmf version to cmdlets presence - https://github.com/ansible/ansible/issues/63003
+      - win_firewall_rule - add parameter to support ICMP Types and Codes (https://github.com/ansible/ansible/issues/46809)
+      - win_iis_webapplication - add new options ``connect_as``, ``username``, ``password``.
+      - win_iis_webapplication - now uses the current application pool of the website
+        instead of the DefaultAppPool if none was specified.
+      - win_nssm - Implement additional parameters - (https://github.com/ansible/ansible/issues/62620)
+      - win_pester - Only execute ``*.tests.ps1`` in ``path`` to match the default
+        behaviour in Pester - https://github.com/ansible/ansible/issues/55736
+      release_summary: 'This is the first proper release of the ``community.windows``
+        collection on 2020-07-18.
+
+        The changelog describes all changes made to the modules and plugins included
+        in this collection since Ansible 2.9.0.
+
+        '
+      removed_features:
+      - win_disk_image - removed the deprecated return value ``mount_path`` in favour
+        of ``mount_paths``.
+    fragments:
+    - 56033-win_iis_webapplication-add-authentication-options.yml
+    - 56966-win_format-allocation-unit-size.yml
+    - 58225-win_partition-maximum-partition-size.yml
+    - 61227-win_iis_webapplication-apppool-change.yml
+    - 65138-Windows_Multidomain_support.yml
+    - 93-win_domain_computer-offline-domain-join.yml
+    - psexec-kerb-and-interactive.yaml
+    - summary-0.2.0.yml
+    - win-unzip-check-extraction-path.yml
+    - win_credential-wildcard.yaml
+    - win_disk_facts-Set-output-array-order-by-disk-number.yml
+    - win_disk_image_mount_path.yml
+    - win_domain_computer-credential.yaml
+    - win_domain_computer-idempotence.yaml
+    - win_domain_user-group-missing.yaml
+    - win_domain_user-identity.yaml
+    - win_firewall-Change-req-check-from-wmf-version-to-cmdlets-presence.yml
+    - win_firewall_rule-add-support-for-icmptypecode.yml
+    - win_format-Idem-not-working-if-file-exist-but-same-fs.yml
+    - win_iis_webapppool-check-mode.yaml
+    - win_iis_website-restarted.yaml
+    - win_nssm-Implement-additional-parameters.yml
+    - win_partition-var.yaml
+    - win_pester-path-behaviour.yaml
+    - win_timezone-Allow-dstoff.yml
+    - win_unzip-paths.yaml
+    release_date: '2020-07-18'

docs/community.windows.laps_password_lookup.rst

@@ -23,7 +23,7 @@ Synopsis
 
 Requirements
 ------------
-The below requirements are needed on the local master node that executes this lookup.
+The below requirements are needed on the local Ansible controller node that executes this lookup.
 
 - python-ldap
 

docs/community.windows.psexec_module.rst

@@ -423,8 +423,8 @@ See Also
 
 .. seealso::
 
-   :ref:`raw_module`
-      The official documentation on the **raw** module.
+   :ref:`ansible.builtin.raw_module`
+      The official documentation on the **ansible.builtin.raw** module.
    :ref:`ansible.windows.win_command_module`
       The official documentation on the **ansible.windows.win_command** module.
    :ref:`community.windows.win_psexec_module`

docs/community.windows.win_dns_zone_module.rst

@@ -191,7 +191,7 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
+    
     - name: Ensure primary zone is present
       community.windows.win_dns_zone:
         name: wpinner.euc.vmware.com

docs/community.windows.win_iis_website_module.rst

@@ -105,6 +105,11 @@ Parameters
                                                                                                                                                             </td>
                                                                 <td>
                                             <div>Custom site Parameters from string where properties are separated by a pipe and property name/values by colon Ex. &quot;foo:1|bar:2&quot;</div>
+                                            <div>Some custom parameters that you can use are listed below, this isn&#x27;t a definitive list but some common parameters.</div>
+                                            <div><code>logfile.directory</code> - Physical path to store Logs, e.g. <code>D:\IIS-LOGs\</code>.</div>
+                                            <div><code>logfile.period</code> - Log file rollover scheduled accepting these values, how frequently the log file should be rolled-over, e.g. <code>Hourly, Daily, Weekly, Monthly</code>.</div>
+                                            <div><code>logfile.LogFormat</code> - Log file format, by default IIS uses <code>W3C</code>.</div>
+                                            <div><code>logfile.truncateSize</code> - The size at which the log file contents will be trunsted, expressed in bytes.</div>
                                                         </td>
             </tr>
                                 <tr>
@@ -237,6 +242,19 @@ Examples
         name: "Default Web Site"
         state: absent
 
+    # Create a WebSite with custom Logging configuration (Logs Location, Format and Rolling Over).
+
+    - name: Creating WebSite with Custom Log location, Format 3WC and rolling over every hour.
+      community.windows.win_iis_website:
+        name: MyCustom_Web_Shop_Site
+        state: started
+        port: 80
+        ip: '*'
+        hostname: '*'
+        physical_path: D:\wwwroot\websites\my-shop-site
+        parameters: logfile.directory:D:\IIS-LOGS\websites\my-shop-site|logfile.period:Hourly|logFile.logFormat:W3C
+        application_pool: my-shop-site
+
     # Some commandline examples:
 
     # This return information about an existing host

docs/community.windows.win_lineinfile_module.rst

@@ -263,10 +263,10 @@ See Also
 
 .. seealso::
 
-   :ref:`assemble_module`
-      The official documentation on the **assemble** module.
-   :ref:`lineinfile_module`
-      The official documentation on the **lineinfile** module.
+   :ref:`ansible.builtin.assemble_module`
+      The official documentation on the **ansible.builtin.assemble** module.
+   :ref:`ansible.builtin.lineinfile_module`
+      The official documentation on the **ansible.builtin.lineinfile** module.
 
 
 Examples

docs/community.windows.win_psexec_module.rst

@@ -341,8 +341,8 @@ See Also
 
    :ref:`community.windows.psexec_module`
       The official documentation on the **community.windows.psexec** module.
-   :ref:`raw_module`
-      The official documentation on the **raw** module.
+   :ref:`ansible.builtin.raw_module`
+      The official documentation on the **ansible.builtin.raw** module.
    :ref:`ansible.windows.win_command_module`
       The official documentation on the **ansible.windows.win_command** module.
    :ref:`ansible.windows.win_shell_module`

docs/community.windows.win_psscript_info_module.rst

@@ -95,7 +95,7 @@ Examples
 
 .. code-block:: yaml+jinja
 
-
+    
     - name: Get info about all script on the system
       community.windows.win_psscript_info:
 
@@ -448,10 +448,10 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                                             <div style="font-size: smaller"><b>Sample:</b></div>
                                                 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">## 1.5.5
     - Add optional param for detailed info
-
+    
     ## 1.4.7
     - Bug fix for deadlock when getting parameters in an event
-
+    
     ## 1.1.4
     - Bug fix when installing package from private feeds</div>
                                     </td>
@@ -549,7 +549,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                                                 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">1.2.3</div>
                                     </td>
             </tr>
-
+                    
                                         </table>
     <br/><br/>