> User Documentation Home

User Handbook
Tutorials
Resources

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.

Git Changelog

View this plugin on the Plugins site

getHighestSemanticVersion: Get the highest version, determined by tags in repo. Also tag available as '.findTag().orElse("")'.

  • repo (optional)
    • Type: String

getNextSemanticVersion: Next semantic version based on tags and conventional commits in Git repository

  • from (optional)
      Nested Object
    • type
      • Values: REF, COMMIT
    • value
      • Type: String
  • majorPattern (optional)
    • Type: String
  • minorPattern (optional)
    • Type: String
  • patchPattern (optional)
    • Type: String
  • repo (optional)
    • Type: String
  • to (optional)
      Nested Object
    • type
      • Values: REF, COMMIT
    • value
      • Type: String

gitChangelog: Changelog from Git repository

  • customIssues (optional)
      Array / List of Nested Object
    • name
      • Type: String
    • issuePattern
      • Type: String
    • link (optional)
      • Type: String
    • title (optional)
      • Type: String
  • dateFormat (optional)
    • Type: String
  • extendedVariables (optional)
      Array / List of Nested Object
    • name
      • Type: String
    • value
      • Type: String
  • from (optional)
      Nested Object
    • type
      • Values: REF, COMMIT
    • value
      • Type: String
  • gitHub (optional)
      Nested Object
    • api
      • Type: String
    • token
      • Type: String
    • issuePattern
      • Type: String
  • gitLab (optional)
      Nested Object
    • server
      • Type: String
    • token
      • Type: String
    • issuePattern
      • Type: String
    • projectName
      • Type: String
  • ignoreCommitsIfMessageMatches (optional)
    • Type: String
  • ignoreCommitsIfOlderThan (optional)
    • Type: String
  • ignoreCommitsWithoutIssue (optional)
    • Type: boolean
  • ignoreTagsIfNameMatches (optional)
    • Type: String
  • javascriptHelper (optional)
    • Type: String
  • jira (optional)
      Nested Object
    • server
      • Type: String
    • issuePattern
      • Type: String
    • username
      • Type: String
    • password
      • Type: String
    • basicAuthString
      • Type: String
    • bearer
      • Type: String
  • noIssueName (optional)
    • Type: String
  • readableTagName (optional)
    • Type: String
  • redmine (optional)
      Nested Object
    • server
      • Type: String
    • issuePattern
      • Type: String
    • username
      • Type: String
    • password
      • Type: String
    • token
      • Type: String
  • removeIssueFromMessage (optional)
    • Type: boolean
  • repo (optional)
    • Type: String
  • returnType (optional)
    • Values: STRING, CONTEXT
  • template (optional)
    • Type: String
  • timeZone (optional)
    • Type: String
  • to (optional)
      Nested Object
    • type
      • Values: REF, COMMIT
    • value
      • Type: String
  • untaggedName (optional)
    • Type: String

step([$class: 'GitChangelogRecorder']): Git Changelog

See Git Changelog Plugin for details on how to configure and use this plugin.

  • config
      Nested Object
    • configFile (optional)
      • Type: String
    • createFileTemplateContent (optional)
      • Type: String
    • createFileTemplateFile (optional)
      • Type: String
    • createFileUseTemplateContent (optional)
      • Type: boolean
    • createFileUseTemplateFile (optional)
      • Type: boolean
    • customIssues (optional)
        Array / List of Nested Object
      • name
        • Type: String
      • pattern
        • Type: String
      • link
        • Type: String
      • title
        • Type: String
    • dateFormat (optional)
      • Type: String
    • file (optional)
      • Type: String
    • fromReference (optional)
      • Type: String
    • fromType (optional)
      • Type: String
    • gitHubApi (optional)
      • Type: String
    • gitHubApiTokenCredentialsId (optional)
      • Type: String
    • gitHubIssuePattern (optional)
      • Type: String
    • gitHubToken (optional)
      • Type: String
    • gitLabApiTokenCredentialsId (optional)
      • Type: String
    • gitLabProjectName (optional)
      • Type: String
    • gitLabServer (optional)
      • Type: String
    • gitLabToken (optional)
      • Type: String
    • ignoreCommitsIfMessageMatches (optional)
      • Type: String
    • ignoreCommitsWithoutIssue (optional)
      • Type: boolean
    • ignoreTagsIfNameMatches (optional)
      • Type: String
    • jiraBasicAuthString (optional)
      • Type: String
    • jiraBasicAuthStringCredentialsId (optional)
      • Type: String
    • jiraBearer (optional)
      • Type: String
    • jiraBearerCredentialsId (optional)
      • Type: String
    • jiraIssuePattern (optional)
      • Type: String
    • jiraPassword (optional)
      • Type: String
    • jiraServer (optional)
      • Type: String
    • jiraUsername (optional)
      • Type: String
    • jiraUsernamePasswordCredentialsId (optional)
      • Type: String
    • noIssueName (optional)
      • Type: String
    • readableTagName (optional)
      • Type: String
    • redmineIssuePattern (optional)
      • Type: String
    • redminePassword (optional)
      • Type: String
    • redmineServer (optional)
      • Type: String
    • redmineToken (optional)
      • Type: String
    • redmineTokenCredentialsId (optional)
      • Type: String
    • redmineUserNamePasswordCredentialsId (optional)
      • Type: String
    • redmineUsername (optional)
      • Type: String
    • showSummary (optional)
      • Type: boolean
    • showSummaryTemplateContent (optional)
      • Type: String
    • showSummaryTemplateFile (optional)
      • Type: String
    • showSummaryUseTemplateContent (optional)
      • Type: boolean
    • showSummaryUseTemplateFile (optional)
      • Type: boolean
    • subDirectory (optional)
      • Type: String
    • timeZone (optional)
      • Type: String
    • toReference (optional)
      • Type: String
    • toType (optional)
      • Type: String
    • untaggedName (optional)
      • Type: String
    • useConfigFile (optional)
      • Type: boolean
    • useFile (optional)
      • Type: boolean
    • useGitHub (optional)
      • Type: boolean
    • useGitLab (optional)
      • Type: boolean
    • useIgnoreTagsIfNameMatches (optional)
      • Type: boolean
    • useJira (optional)
      • Type: boolean
    • useReadableTagName (optional)
      • Type: boolean
    • useRedmine (optional)
      • Type: boolean
    • useSubDirectory (optional)
      • Type: boolean

Was this page helpful?

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.