Git Collect is a Jenkins plugin that allows you to register an already existing local Git repository into the Jenkins build data without performing a network fetch, clone, or checkout.
This is ideal for complex pipelines where the source code is retrieved by external scripts, pre-mounted volumes, or other tools, but you still want Jenkins to record the Git revision, branch information, and be compatible as plugin like git-forensic.
- No Network Activity: Strictly operates on the local file system.
- Pipeline Support: First-class support for Jenkins Pipeline via
collectGit. - Accurate Revision Tracking: Distinguishes between the User Intent (Marked Revision, e.g.,
origin/master) and the Actual Result (Built Revision, e.g.,SHA1). - Compatibility: Generates standard
BuildDataactions, making it compatible with other plugins that rely on the standard Git plugin data structures.
The plugin exposes the collectGit step.
If you just want to register a repo found in the workspace:
pipeline {
agent any
stages {
stage('Checkout') {
steps {
// Assume code is downloaded here by a script/tool
sh './download_code.sh'
}
}
stage('Register Git Data') {
steps {
// Looks for .git in the 'src' folder
collectGit path: 'src'
}
}
stage('Register Git Data from a marked commit') {
steps {
// Looks for .git in the 'src' folder, and reference commit 'markedCommit'
collectGit path: 'src', markedCommit: '64ed978d54d2db4522a326c3f5cba6f8d4b41f8f'
}
}
stage('Register Git Data from a marked commit, including changelog') {
steps {
// Looks for .git in the 'src' folder, and reference commit 'markedCommit'
collectGit path: 'src', markedCommit: '64ed978d54d2db4522a326c3f5cba6f8d4b41f8f', changelog: true
}
}
}
}