diff options
| author | Tim Smith <tsmith@chef.io> | 2020-10-15 16:03:45 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-15 16:03:45 -0700 |
| commit | 27bd4d9dc82be94873418af1e153d73d5cced97f (patch) | |
| tree | 83f49255f0f7310aa66680f2201091fbd24695d5 | |
| parent | 8547d7187c3f81671dedbeb23d5041e5da59d5c1 (diff) | |
| parent | 2a55c247a066324ac1c55fff0578fe2c9cb91899 (diff) | |
| download | chef-27bd4d9dc82be94873418af1e153d73d5cced97f.tar.gz | |
Merge pull request #10508 from chef/powershell_script-description
Signed-off-by: Tim Smith <tsmith@chef.io>
| -rw-r--r-- | lib/chef/resource/powershell_script.rb | 13 |
1 files changed, 5 insertions, 8 deletions
diff --git a/lib/chef/resource/powershell_script.rb b/lib/chef/resource/powershell_script.rb index 5c9b540f55..768d5f6ca7 100644 --- a/lib/chef/resource/powershell_script.rb +++ b/lib/chef/resource/powershell_script.rb @@ -58,14 +58,11 @@ class Chef ``` DESC - description "Use the **powershell_script** resource to execute a script using the Windows PowerShell"\ - " interpreter, much like how the script and script-based resources—bash, csh, perl, python,"\ - " and ruby—are used. The powershell_script is specific to the Microsoft Windows platform"\ - " and the Windows PowerShell interpreter.\n\n The powershell_script resource creates and"\ - " executes a temporary file (similar to how the script resource behaves), rather than running"\ - " the command inline. Commands that are executed with this resource are (by their nature) not"\ - " idempotent, as they are typically unique to the environment in which they are run. Use not_if"\ - " and only_if to guard this resource for idempotence." + description <<~DESC + Use the **powershell_script** resource to execute a script using the Windows PowerShell interpreter, much like how the script and script-based resources **bash**, **csh**, **perl**, **python**, and **ruby** are used. The **powershell_script** resource is specific to the Microsoft Windows platform, but may use both the the Windows PowerShell interpreter or the PowerShell Core (pwsh) interpreter as of Chef Infra Client 16.6 and later. + + The **powershell_script** resource creates and executes a temporary file rather than running the command inline. Commands that are executed with this resource are (by their nature) not idempotent, as they are typically unique to the environment in which they are run. Use `not_if` and `only_if` conditionals to guard this resource for idempotence. + DESC def initialize(*args) super |