-
Notifications
You must be signed in to change notification settings - Fork 227
(BOLT-1379) (docs) 'file upload' can handle directories #1023
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(BOLT-1379) (docs) 'file upload' can handle directories #1023
Conversation
|
Appveyor failure looks unrelated (I hope)? |
8a6a06b to
589a5b4
Compare
|
CLA signed by all contributors. |
|
We generate https://github.com/puppetlabs/bolt/blob/master/pre-docs/plan_functions.md with a rake task based on puppet-strings documentation in plan function definitions. You can run Lines 52 to 57 in 46434af
I was looking for places in the docs where we may clarify this, but I think it is missing. Maybe we could add it to: https://github.com/puppetlabs/bolt/blob/master/pre-docs/bolt_command_reference.md#bolt-command-reference |
|
unfortunately this needs a ticket or it won't get copy pasted into the real docs |
589a5b4 to
4842fbd
Compare
|
Ok, thanks both - I've created a JIRA ticket and regenerated the markdown, and added mentions of directories in several other places. |
4842fbd to
576624f
Compare
|
I'm not sure I understand why Travis is failing |
|
@casey it is unrelated to this PR. We have a regression in the puppet-resource_api gem. We are working on a fix for now. Thanks! |
lib/bolt/executor.rb
Outdated
|
|
||
| def upload_file(targets, source, destination, options = {}) | ||
| description = options.fetch('_description', "file upload from #{source} to #{destination}") | ||
| description = options.fetch('_description', "file or directory upload from #{source} to #{destination}") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this logging/outputting is intended more to map to the action file upload rather than describe to the user the behavior of the action. I would lean toward leaving that part out and instead just focus on documenting what to expect with file upload.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, removed the executor changes
The 'file upload' command and the 'upload_file' function are able to upload directories as well as individual files - these changes explicitly mention that in the docs.
576624f to
072d954
Compare
Update the string docs for the upload_file boltlib function to mention
that the function is able to upload directories as well as files.