summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2017-08-28 11:32:15 -0700
committerGitHub <noreply@github.com>2017-08-28 11:32:15 -0700
commit887a9a4e2c024a1b2e95bacf7125a54538bf23fc (patch)
tree7b208068bbe30e8a1a7eaf45a0b5eb7fe2bc862d
parent54cc303e5e68ce9ddd1abfc949151a759ba7e01e (diff)
parent913a67da9d53377fea841479a551a7ee255f8438 (diff)
downloadchef-887a9a4e2c024a1b2e95bacf7125a54538bf23fc.tar.gz
Merge pull request #6344 from MsysTechnologiesllc/nim/windows_path_docs
[MSYS-645] Updated release_notes for windows_path
-rw-r--r--RELEASE_NOTES.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index c29cd049ff..8f6cc3b05f 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -1,5 +1,38 @@
_This file holds "in progress" release notes for the current release under development and is intended for consumption by the Chef Documentation team. Please see <https://docs.chef.io/release_notes.html> for the official Chef release notes._
+# Unreleased:
+
+## windows_path resource
+
+`windows_path` resource has been moved to core chef from windows cookbook. Use the `windows_path` resource to manage the path environment variable on Microsoft Windows.
+
+### Actions
+
+- `:add` - Add an item to the system path
+- `:remove` - Remove an item from the system path
+
+### Properties
+
+- `path` - Name attribute. The name of the value to add to the system path
+
+### Examples
+
+Add Sysinternals to the system path
+
+```ruby
+windows_path 'C:\Sysinternals' do
+ action :add
+end
+```
+
+Remove 7-Zip from the system path
+
+```ruby
+windows_path 'C:\7-Zip' do
+ action :remove
+end
+```
+
# Chef Client Release Notes 13.3:
## Unprivileged Symlink Creation on Windows