Package hudson.plugins.git

Class GitBranchTokenMacro

java.lang.Object
org.jenkinsci.plugins.tokenmacro.TokenMacro
org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro
hudson.plugins.git.GitBranchTokenMacro
All Implemented Interfaces:
ExtensionPoint
@Extension(optional=true) public class GitBranchTokenMacro extends org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro
GIT_BRANCH token that expands to the branch(es) that was built.
Author:
Kohsuke Kawaguchi

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

    org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro.Parameter

    Nested classes/interfaces inherited from interface hudson.ExtensionPoint

    ExtensionPoint.LegacyInstancesAreScopedToHudson

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    boolean
    all
    If true, list up all the branches not just the first one.
    boolean
    fullName
    If true, include all the prefixes of the branch name

    Fields inherited from class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

    escapeHtml

  • Constructor Summary

    Constructors
    Constructor
    Description
    GitBranchTokenMacro()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    acceptsMacroName(String macroName)
     
    String
    evaluate(AbstractBuild<?,?> context, TaskListener listener, String macroName)
     
    String
    evaluate(Run<?,?> context, FilePath workspace, TaskListener listener, String macroName)
     

    Methods inherited from class org.jenkinsci.plugins.tokenmacro.DataBoundTokenMacro

    evaluate, evaluate, handlesHtmlEscapeInternally, hasNestedContent

    Methods inherited from class org.jenkinsci.plugins.tokenmacro.TokenMacro

    all, expand, expand, expand, expand, expandAll, expandAll, expandAll, expandAll, getAcceptedMacroNames, getAutoCompleteList, getPreviousRun, getWorkspace

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • all

      public boolean all
      If true, list up all the branches not just the first one.

    • fullName

      public boolean fullName
      If true, include all the prefixes of the branch name

  • Constructor Details

    • GitBranchTokenMacro

      public GitBranchTokenMacro()

  • Method Details