Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 17, 2025

The file_uploader transformer lacked documentation, making it difficult for users to discover and use this functionality for uploading files from local to remote nodes.

Changes

  • Added documentation section in docs/run_test/transformers.rst following existing transformer documentation patterns
  • Documented required parameters: source (local path), destination (remote path), files (list of file names)
  • Documented output variable: uploaded_files
  • Included YAML usage example:
transformer:
  - type: file_uploader
    phase: environment_connected
    source: "/local/path/to/files"
    destination: "/remote/path/to/upload"
    files:
      - "file1.txt"
      - "file2.sh"
      - "config.yaml"

The transformer creates the destination directory if it doesn't exist and uploads each specified file from the source directory. It should be used in the environment_connected phase when the environment is already deployed and connected, so no explicit connection configuration is needed.

File Uploader Documentation

Original prompt

add doc for file_uploader transformer


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: LiliDeng <10083705+LiliDeng@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for file uploader transformer Add documentation for file_uploader transformer Nov 17, 2025
Copilot AI requested a review from LiliDeng November 17, 2025 15:32
…nd remove connection section

Co-authored-by: LiliDeng <10083705+LiliDeng@users.noreply.github.com>
Copilot AI requested a review from LiliDeng November 18, 2025 02:00
@LiliDeng LiliDeng marked this pull request as ready for review November 18, 2025 02:51
@adityagesh
Copy link
Collaborator

LGTM

@LiliDeng LiliDeng merged commit 9c75b2d into main Nov 18, 2025
84 checks passed
@LiliDeng LiliDeng deleted the copilot/add-doc-file-uploader-transformer branch November 18, 2025 06:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants