prefect.deployments.steps.pull
¶
Core set of steps for specifying a Prefect project pull step.
git_clone
async
¶
Clones a git repository into the current working directory.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
repository |
str
|
the URL of the repository to clone |
required |
branch |
Optional[str]
|
the branch to clone; if not provided, the default branch will be used |
None
|
include_submodules |
bool
|
whether to include git submodules when cloning the repository |
False
|
access_token |
Optional[str]
|
an access token to use for cloning the repository; if not provided the repository will be cloned using the default git credentials |
None
|
credentials |
Optional[Block]
|
a GitHubCredentials, GitLabCredentials, or BitBucketCredentials block can be used to specify the credentials to use for cloning the repository. |
None
|
Returns:
Name | Type | Description |
---|---|---|
dict |
dict
|
a dictionary containing a |
Raises:
Type | Description |
---|---|
CalledProcessError
|
if the git clone command fails for any reason |
Examples:
Clone a public repository:
pull:
- prefect.deployments.steps.git_clone:
repository: https://github.com/PrefectHQ/prefect.git
Clone a branch of a public repository:
pull:
- prefect.deployments.steps.git_clone:
repository: https://github.com/PrefectHQ/prefect.git
branch: my-branch
Clone a private repository using a GitHubCredentials block:
pull:
- prefect.deployments.steps.git_clone:
repository: https://github.com/org/repo.git
credentials: "{{ prefect.blocks.github-credentials.my-github-credentials-block }}"
Clone a private repository using an access token:
pull:
- prefect.deployments.steps.git_clone:
repository: https://github.com/org/repo.git
access_token: "{{ prefect.blocks.secret.github-access-token }}" # Requires creation of a Secret block
x-token-auth
)
in your secret block. Refer to your git providers documentation for the correct authentication schema.
Clone a repository with submodules:
pull:
- prefect.deployments.steps.git_clone:
repository: https://github.com/org/repo.git
include_submodules: true
Clone a repository with an SSH key (note that the SSH key must be added to the worker before executing flows):
pull:
- prefect.deployments.steps.git_clone:
repository: git@github.com:org/repo.git
Source code in prefect/deployments/steps/pull.py
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 |
|
git_clone_project
async
¶
Deprecated. Use git_clone
instead.
Source code in prefect/deployments/steps/pull.py
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
|
pull_from_remote_storage
async
¶
Pulls code from a remote storage location into the current working directory.
Works with protocols supported by fsspec
.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url |
str
|
the URL of the remote storage location. Should be a valid |
required |
**settings |
Any
|
any additional settings to pass the |
{}
|
Returns:
Name | Type | Description |
---|---|---|
dict |
a dictionary containing a |
Examples:
Pull code from a remote storage location:
pull:
- prefect.deployments.steps.pull_from_remote_storage:
url: s3://my-bucket/my-folder
Pull code from a remote storage location with additional settings:
pull:
- prefect.deployments.steps.pull_from_remote_storage:
url: s3://my-bucket/my-folder
key: {{ prefect.blocks.secret.my-aws-access-key }}}
secret: {{ prefect.blocks.secret.my-aws-secret-key }}}
Source code in prefect/deployments/steps/pull.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
|
pull_with_block
async
¶
Pulls code using a block.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
block_document_name |
str
|
The name of the block document to use |
required |
block_type_slug |
str
|
The slug of the type of block to use |
required |
Source code in prefect/deployments/steps/pull.py
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
|
set_working_directory
¶
Sets the working directory; works with both absolute and relative paths.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
directory |
str
|
the directory to set as the working directory |
required |
Returns:
Name | Type | Description |
---|---|---|
dict |
dict
|
a dictionary containing a |
Source code in prefect/deployments/steps/pull.py
17 18 19 20 21 22 23 24 25 26 27 28 29 |
|