YAML Schema
resources:
- name: <string>
type: RemoteFile
configuration:
source: <file server integration name>
fileLocation: <string> # optional
fileName: <string> # optional
fileDateTime: <string> # optional
Tags
name
An alphanumeric string (underscores are permitted) that identifies the resource.
type
Must be RemoteFile for this resource type.
configuration
Specifies all configuration selections for the resource.
Tag | Description | Required/Optional |
|---|---|---|
source | The name of an integration of one the following types: | Required |
fileLocation | Directory path on the remote file server where the file is located | Optional |
fileName | The name of the file | Optional |
fileDateTime | The date and time of the file | Optional |
Environment Variables
Whenever RemoteFile is used in a step, a set of environment variables is automatically made available that you can use in your step.
| Environment Variable | Description |
|---|---|
res_<resource_name>_name | Name of the resource |
res_<resource_name>_source_name | Name of the integration the file is associated with |
res_<resource_name>_fileLocation | The directory containing files for the resource |
res_<resource_name>_fileName | The name of the file |
res_<resource_name>_fileDateTime | The date and time of the file |
Examples
- This examples requires an Artifactory Integration.
- The Pipelines DSL for this example is available in this repository in the JFrog GitHub account.
resources:
- name: RemoteFile_1
type: RemoteFile
configuration:
source: s_artifactory
fileLocation: example-repo-local/setup/help # optional
fileName: something.txt # optional
fileDateTime: 19/12/19 # optional
pipelines:
- name: pipelines_1
steps:
- name: REFILE_1
type: PowerShell
configuration:
nodePool: win_2019
integrations:
- name: s_artifactory
outputResources:
- name: RemoteFile_1
execution:
onExecute:
- write-output "executing step..."
- jfrog rt dl example-repo-local/setup/test.sh
