Plugin procedures can be used in procedure steps, process steps, and pipeline tasks, allowing you to orchestrate third-party tools at the appropriate time in your component, application process, or pipeline.
Clone
Clones a remote repository into a path on the local filesystem.
Input parameters
Parameter | Description | ||
---|---|---|---|
Configuration name |
Required. The previously defined configuration for the plugin. |
||
Destination directory |
Indicates the path where the source tree is created. It can be relative to the job’s workspace. |
||
Git repository |
Required. A Git repository URL. For example, |
||
Clone mirror? |
Creates a mirror of the source repository. It allows for the mirroring of repositories to and from external sources. You can use it to mirror branches, tags, and commits between repositories.
|
||
Path of the reference repo to use during clone |
Specify a folder containing a repository that is used by Git as a reference during clone operations. This option is ignored if the folder is not available on the agent.
|
||
Remote branch |
The name of the Git branch to use. For example, |
||
Tag |
Provide the name of a specific Git tag to check out after the |
||
Commit hash |
The commit hash to update the index.
|
||
Clone submodules? |
After the clone is created, initialize and clone submodules based on the provided Submodules pathspecs. If no Submodules pathspecs are specified, all submodules are initialized and cloned. |
||
Submodules pathspecs |
The list of the submodules' pathspecs delimited by newlines.
|
||
Shallow submodules |
All submodules that are cloned are shallow, with a depth of one.
|
||
Overwrite? |
This option deletes the existing, previously cloned, folder with the repository and runs the clone anew. |
||
Depth |
Create a shallow clone with a history that is truncated to the specified number of revisions.
|
||
Result property sheet |
The results are saved into this property or property sheet. |
Commit
Performs a Git commit and optionally pushes changes to the remote repository.
Input parameters
Parameter | Description |
---|---|
Configuration name |
Required. The previously defined configuration for the plugin. |
Folder |
Required. The folder where files are retrieved from. The folder must be under a Git tree. This means that a .git folder must be present in this folder or in any of its parent folders. |
Files |
Required. The file pattern (or glob pattern) to use to add files to the commit. One pattern per line. For example, |
Commit message |
Required. The commit message for the newly created commit. If not provided, the date and CloudBees CD/RO Job ID are used to identify the commit. |
Author name |
The commit author name. For example, John Wick. |
Author email |
The email address of the commit author. For example, |
Committer name |
The name of the committer. This can be the name of the project or a schedule. For example, |
Committer email |
The email address of the committer. For example, |
Remove missing? |
If selected, any files that are missing from the repository are removed from the SCM. |
Push? |
If selected, the commit is pushed to the remote repository. |
Remote |
If Push? is selected, provide the remote name here.
The default is |
New branch |
If Push? is selected, provide a name of a new branch. |
Fail on empty commit? |
If selected, the procedure fails if there are no changes to commit. |
Result property sheet |
The results are saved into this property or property sheet. |
DeleteBranch
Deletes the existing Git branch.
Input parameters
Parameter | Description |
---|---|
Configuration name |
Required. The previously defined configuration for the plugin. |
Folder |
The folder where files are retrieved from the remote repository. The folder must be under a Git tree and a .git folder must be present in this folder or parent folders. |
Branch to delete |
Required. Provide a name of a branch to delete. |
Branch to switch |
Provide a name of a branch to switch to it before deleting. The default is |
Remote |
Provide the remote name here.
The default is |
Pull
Fetch changes from the remote repository into the local repository. If the local repository does not exist, it is cloned on the first run.
Input parameters
Parameter | Description | ||
---|---|---|---|
Configuration name |
Required. The previously defined configuration for the plugin. |
||
Git repository |
Required. A Git repository URL. For example, |
||
Destination directory |
The path where the source tree is created. It can be relative to the job’s workspace. |
||
Remote branch |
The name of the Git branch to use. For example, |
||
Fetch submodules? |
Specifies if new commits of populated submodules should be fetched and if the working trees of active submodules should be updated.
|
||
Depth |
Limit fetching to the specified number of commits from the tip of each remote branch history.
|
||
Clean the workspace |
Cleans the workspace before or after every checkout by deleting all untracked files and directories, including those specified in
|
||
Files to clean |
The type of files to clean; Untracked only or Changed and untracked. |
||
Metadata property path |
The property sheet where the last commit is stored for the Git log report.
|
||
Result property sheet |
The results are saved into this property or property sheet. |