Add comment to explain current issues with CopyToRemote

Author: KevinFairise2

components/command/filemanager.go

@@ -68,6 +68,8 @@ func (fm *FileManager) CopyFile(name string, localPath, remotePath pulumi.String
 	return fm.runner.newCopyFile(name, localPath, remotePath, opts...)
 }
 
+// CopyToRemoteFile copies a local file to a remote file. Under the hood it uses remote.CopyToRemote, so localPath will be converted to a File Asset, it breaks if the local path is not known at plan time.
+// Ideally it should replace CopyFile but it is not possible due to the limitation of CopyToRemote for now.
 func (fm *FileManager) CopyToRemoteFile(name string, localPath, remotePath pulumi.StringInput, opts ...pulumi.ResourceOption) (pulumi.Resource, error) {
 	return fm.command.NewCopyToRemoteFile(fm.runner, name, localPath, remotePath, opts...)
 }

components/command/osCommand.go

@@ -34,6 +34,7 @@ type OSCommand interface {
 	NewCopyToRemoteFile(runner Runner, name string, localPath, remotePath pulumi.StringInput, opts ...pulumi.ResourceOption) (pulumi.Resource, error)
 	copyLocalFile(runner *LocalRunner, name string, src, dst pulumi.StringInput, opts ...pulumi.ResourceOption) (pulumi.Resource, error)
 	copyRemoteFile(runner *RemoteRunner, name string, src, dst pulumi.StringInput, opts ...pulumi.ResourceOption) (pulumi.Resource, error)
+	// copyToRemoteFileV2 rely on CopyToRemote to copy files to remote, which uses a File asset instead of a Pulumi.StringInput with the path. It breaks when the path is not determined at runtime.
 	copyRemoteFileV2(runner *RemoteRunner, name string, src, dst pulumi.StringInput, opts ...pulumi.ResourceOption) (pulumi.Resource, error)
 }