The following plugin provides functionality available through Pipeline-compatible steps. Read more about how to integrate steps into your Pipeline in the Steps section of the Pipeline Syntax page.
For a list of other such plugins, see the Pipeline Steps Reference page.
getHighestSemanticVersion
: Get the highest version, determined by tags in repo. Also tag available as '.findTag().orElse("")'.getNextSemanticVersion
: Next semantic version based on tags and conventional commits in Git repositorygitChangelog
: Changelog from Git repositorystep([$class: 'GitChangelogRecorder'])
: Git ChangeloggetHighestSemanticVersion
: Get the highest version, determined by tags in repo. Also tag available as '.findTag().orElse("")'.from
(optional)
type
type
REF
, COMMIT
value : String
value : String
repo : String
(optional)
to
(optional)
type
type
REF
, COMMIT
value : String
value : String
getNextSemanticVersion
: Next semantic version based on tags and conventional commits in Git repositoryfrom
(optional)
type
type
REF
, COMMIT
value : String
value : String
majorPattern : String
(optional)
minorPattern : String
(optional)
patchPattern : String
(optional)
repo : String
(optional)
to
(optional)
type
type
REF
, COMMIT
value : String
value : String
gitChangelog
: Changelog from Git repositorycustomIssues
(optional)
name : String
name : String
issuePattern : String
issuePattern : String
link : String
link : String
(optional)
title : String
title : String
(optional)
dateFormat : String
(optional)
extendedVariables
(optional)
name : String
name : String
value : String
value : String
from
(optional)
type
type
REF
, COMMIT
value : String
value : String
gitHub
(optional)
api : String
api : String
token : String
token : String
issuePattern : String
issuePattern : String
gitLab
(optional)
server : String
server : String
token : String
token : String
issuePattern : String
issuePattern : String
projectName : String
projectName : String
ignoreCommitsIfMessageMatches : String
(optional)
ignoreCommitsIfOlderThan : String
(optional)
ignoreCommitsWithoutIssue : boolean
(optional)
ignoreTagsIfNameMatches : String
(optional)
javascriptHelper : String
(optional)
jira
(optional)
server : String
server : String
issuePattern : String
issuePattern : String
username : String
username : String
password : String
password : String
basicAuthString : String
basicAuthString : String
bearer : String
bearer : String
noIssueName : String
(optional)
readableTagName : String
(optional)
redmine
(optional)
server : String
server : String
issuePattern : String
issuePattern : String
username : String
username : String
password : String
password : String
token : String
token : String
removeIssueFromMessage : boolean
(optional)
repo : String
(optional)
returnType
(optional)
STRING
, CONTEXT
template : String
(optional)
timeZone : String
(optional)
to
(optional)
type
type
REF
, COMMIT
value : String
value : String
untaggedName : String
(optional)
step([$class: 'GitChangelogRecorder'])
: Git ChangelogSee Git Changelog Plugin for details on how to configure and use this plugin.
config
configFile : String
configFile : String
(optional)
createFileTemplateContent : String
createFileTemplateContent : String
(optional)
createFileTemplateFile : String
createFileTemplateFile : String
(optional)
createFileUseTemplateContent : boolean
createFileUseTemplateContent : boolean
(optional)
createFileUseTemplateFile : boolean
createFileUseTemplateFile : boolean
(optional)
customIssues
customIssues
(optional)
name : String
name : String
pattern : String
pattern : String
link : String
link : String
title : String
title : String
dateFormat : String
dateFormat : String
(optional)
file : String
file : String
(optional)
fromReference : String
fromReference : String
(optional)
fromType : String
fromType : String
(optional)
gitHubApi : String
gitHubApi : String
(optional)
gitHubApiTokenCredentialsId : String
gitHubApiTokenCredentialsId : String
(optional)
gitHubIssuePattern : String
gitHubIssuePattern : String
(optional)
gitHubToken : String
gitHubToken : String
(optional)
gitLabApiTokenCredentialsId : String
gitLabApiTokenCredentialsId : String
(optional)
gitLabProjectName : String
gitLabProjectName : String
(optional)
gitLabServer : String
gitLabServer : String
(optional)
gitLabToken : String
gitLabToken : String
(optional)
ignoreCommitsIfMessageMatches : String
ignoreCommitsIfMessageMatches : String
(optional)
ignoreCommitsWithoutIssue : boolean
ignoreCommitsWithoutIssue : boolean
(optional)
ignoreTagsIfNameMatches : String
ignoreTagsIfNameMatches : String
(optional)
jiraBasicAuthString : String
jiraBasicAuthString : String
(optional)
jiraBasicAuthStringCredentialsId : String
jiraBasicAuthStringCredentialsId : String
(optional)
jiraBearer : String
jiraBearer : String
(optional)
jiraBearerCredentialsId : String
jiraBearerCredentialsId : String
(optional)
jiraIssuePattern : String
jiraIssuePattern : String
(optional)
jiraPassword : String
jiraPassword : String
(optional)
jiraServer : String
jiraServer : String
(optional)
jiraUsername : String
jiraUsername : String
(optional)
jiraUsernamePasswordCredentialsId : String
jiraUsernamePasswordCredentialsId : String
(optional)
noIssueName : String
noIssueName : String
(optional)
readableTagName : String
readableTagName : String
(optional)
redmineIssuePattern : String
redmineIssuePattern : String
(optional)
redminePassword : String
redminePassword : String
(optional)
redmineServer : String
redmineServer : String
(optional)
redmineToken : String
redmineToken : String
(optional)
redmineTokenCredentialsId : String
redmineTokenCredentialsId : String
(optional)
redmineUserNamePasswordCredentialsId : String
redmineUserNamePasswordCredentialsId : String
(optional)
redmineUsername : String
redmineUsername : String
(optional)
showSummary : boolean
showSummary : boolean
(optional)
showSummaryTemplateContent : String
showSummaryTemplateContent : String
(optional)
showSummaryTemplateFile : String
showSummaryTemplateFile : String
(optional)
showSummaryUseTemplateContent : boolean
showSummaryUseTemplateContent : boolean
(optional)
showSummaryUseTemplateFile : boolean
showSummaryUseTemplateFile : boolean
(optional)
subDirectory : String
subDirectory : String
(optional)
timeZone : String
timeZone : String
(optional)
toReference : String
toReference : String
(optional)
toType : String
toType : String
(optional)
untaggedName : String
untaggedName : String
(optional)
useConfigFile : boolean
useConfigFile : boolean
(optional)
useFile : boolean
useFile : boolean
(optional)
useGitHub : boolean
useGitHub : boolean
(optional)
useGitLab : boolean
useGitLab : boolean
(optional)
useIgnoreTagsIfNameMatches : boolean
useIgnoreTagsIfNameMatches : boolean
(optional)
useJira : boolean
useJira : boolean
(optional)
useReadableTagName : boolean
useReadableTagName : boolean
(optional)
useRedmine : boolean
useRedmine : boolean
(optional)
useSubDirectory : boolean
useSubDirectory : boolean
(optional)
Please submit your feedback about this page through this quick form.
Alternatively, if you don't wish to complete the quick form, you can simply indicate if you found this page helpful?
See existing feedback here.