Git for IBM DevOps Build - Steps

Steps

Steps

Process steps in the Git plug-in

• Create GitHub Status
• Git Changelog
• Git Checkout
• Git Cleanup
• Git Create Tag
• Git Quiet Period
• Git Sparse Checkout

Create GitHub Status

Create a commit status in GitHub or GitHub Enterprise.

Name	Type	Description	Required
Base REST URL	String	The base URL of the REST API e.g. https://api.github.com. This value should be left blank to be automatically inferred from GitHubs webhook data, unless a different URL needs be used.	No
Context	String	The service that is providing the status.	No
Description	String	High level summary of the status update.	No
Source Config			No
State	Enumeration:	The state of the status.	Yes

Git Changelog

Perform a Git changelog and publish the results.

Name	Type	Description	Required
Changes URL	String		No
End Date	String	End changelog at this date (yyyy-MM-dd HH:mm:ss z OR E MMM dd HH:mm:ss zzz yyyy OR milliseconds since Unix Epoch)	No
End Revision	String	End changelog at this revision	No
Source Config			No
Start Date	String	Start changelog at this date (yyyy-MM-dd HH:mm:ss z OR E MMM dd HH:mm:ss zzz yyyy OR milliseconds since Unix Epoch)	No
Start Revision	String	Start changelog at this revision	No

Git Checkout

Perform a Git checkout of the workflows source

Name	Type	Description	Required
Clean Workspace	Boolean	Erase all files from the workspace before performing checkout	No
Date	String	Date of sourcecode to checkout (yyyy-MM-dd HH:mm:ss z OR E MMM dd HH:mm:ss zzz yyyy OR milliseconds since Unix Epoch). Defaults to the current time.	No
Source Config			No

Git Cleanup

Perform a cleanup of the Git working directory

Name	Type	Description	Required
Source Config			No

Git Create Tag

Create a tag in Git of the specified working copy.

Name	Type	Description	Required
Message	String	A message for the commit	Yes
Source Config			No
Tag	String	The tag name to create	Yes

Git Quiet Period

Perform a Git changelog for quiet period detection and publish most recent change date within the period.

Name	Type	Description	Required
End Date	String	End changelog at this date (yyyy-MM-dd HH:mm:ss z OR E MMM dd HH:mm:ss zzz yyyy OR milliseconds since Unix Epoch)	No
Source Config			No
Start Date	String	Start changelog at this date (yyyy-MM-dd HH:mm:ss z OR E MMM dd HH:mm:ss zzz yyyy OR milliseconds since Unix Epoch)	No

Git Sparse Checkout

Perform a sparse Git checkout to fetch only specific files (e.g., BuildFile.json for JAC pre-workflow). This is much faster than a full checkout for large repositories.

Name	Type	Description	Required
Fallback Branch	String	Branch to use when the configured branch contains unresolved properties (e.g., for manual builds). Leave empty to fail the step if branch cannot be resolved.	No
Source Config			No
Sparse Patterns	String	Comma-separated list of files or patterns to checkout (e.g., BuildFile.json, config/*.json). Defaults to BuildFile.json	No

Roles in the Git plug-in

The plug-in adds these roles automatically to resources. You cannot add these roles manually.

• Git Repository
• Git Source Repo

Git Repository

Global settings for accessing git repositories.

Name	Type	Description
Command Path	String	The location of the Git executable (e.g. /usr/bin/git), if it is not specified in the PATH.
Disable Build on Draft PR	Boolean	Skip Build triggers on Draft Pull Requests.
Password Script	String	Enter a script or property lookup to obtain the password. This field will only be effective if the Repository Password field is blank.
Repository Base URL	String	A URL prefix for source configurations to specify a relative path to the git repository. (e.g. https://git.example.com/repos or ssh://git.example.com/repos)
Repository Password	Password	The password to use for http(s) access to repositories
Repository Username	String	The username to use for http(s) access to repositories
Use Author Email	Boolean	The plugin will use the committer’s email instead of the author’s name.By default, the author name is used.

Git Source Repo

Name	Type	Description
Branch	String	The remote branch name to check out (defaults to master)
Directory Offset	String	Directory offset from the current jobs working directory. (Use . to clone into the current working directory)
Exclude Filters	String	Exclude this list of usernames
File Filters	String	Restrict changelog to files matching these patterns. Lines start with + to include and to exclude. Wildcards *, **, and ? are allowed.
Remote Name	String	The name to use for the remote (defaults to origin)
Remote URL	String	The path to the project repository e.g. username/project. The value of Remote URL will be appended to the repositorys Base URL
Repository		Select the Git Repository