removeFile (Surround)
- Hayden Mumm
Owned by Hayden Mumm
Remove a file from the repository. The file will stop being tracked by Surround. Files cannot be removed if they are checked out, make sure you remove files before checking them out, or after checking them in.
Environment/Instance Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Surround Executable | FDSURROUND_EXE_PATH | N | Path to the Surround executable. Required only if Surround is not on PATH. |
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| Surround Instance | FDSURROUND_INP_INSTANCE_CODE | Y | The Surround Instance to use. |
| Branch | FDSURROUND_INP_BRANCH | Y | The branch to remove from. |
| Folder | FDSURROUND_INP_FOLDER | Y | The folder in Surround to remove from. |
| Sub Directory | FDSURROUND_INP_DESTINATION_SUBDIRECTORY | N | The sub directory under the temp directory to find the files. |
| File Names | FDSURROUND_INP_FILE_NAMES | Y | Relative path of files to remove, seperated by a semicolon. Files are relative of temp directory and Sub Directory input. |
| Comment | FDSURROUND_INP_COMMENT | N | Comment when removing the files. If none is provided will use 'remove'. |
Artifacts
This operation doesn’t consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the environment/instance.
Endpoint Execution
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
Files cannot be removed if they are checked out, make sure you remove files before checking them out, or after checking them in.
The following macros are not currently supported in the footer:
- style