[JENKINS-30252] Provide easy access to git branch name in multibranch workflow scripts - Jenkins Jira

XML

Word

Printable

Details

Type: Improvement
Status: Resolved (View Workflow)
Priority: Major
Resolution: Fixed
Component/s: branch-api-plugin
Labels:
None

Similar Issues:

Show

Description

Popular maven plugins designed to give you access to the git branch name are ineffective when using the workflow Multibranch Plugin.

The JGit Build Number plugin at https://github.com/alx3apps/jgit-buildnumber falls back to coimmit id because GIT_BRANCH is not getting populated
The Git Commit ID Maven Plugin from https://github.com/ktoso/maven-git-commit-id-plugin also fails to extract the branch (unsure why)

For multbranch builds it's reasonable to expect use cases where the branch info is use to augment artifact names and manifest entries so people can easily distinguish branch built artifacts from one.

Would be nice if the DSL just made this state available - but populating the env would be a nice start.

Attachments

Options
- Sort By Name
- Sort By Date
- Ascending
- Descending
- Thumbnails
- List
- Download All

Attachments

pom.xml
8 kB
2015-09-01 21:04

Issue Links

is blocking

JENKINS-30744 multibranch issues if branch contains /

Closed

is related to

JENKINS-24141 SCM with non-AbstractProject, revisited

Closed

JENKINS-47226 Provide easy access to git branch name in (single branch) Pipeline build

Open

JENKINS-32244 Environment variable for current branch

Resolved

links to

PR 12

Stack Overflow

(1 links to)

Activity

Ascending order - Click to sort in descending order

Ronald Pomeroy created issue - 2015-09-01 21:15

Hide

Permalink

Jesse Glick added a comment - 2015-09-02 07:02

Depends on RFE to let SCM pass environment variables to a Run.

Workaround: env.JOB_NAME

Show

Jesse Glick added a comment - 2015-09-02 07:02 Depends on RFE to let SCM pass environment variables to a Run . Workaround: env.JOB_NAME

Ronald Pomeroy made changes - 2015-09-02 23:18

Field	Original Value	New Value
Comment	[ I tried to log out the env.JOB_NAME with echo " * ${env.JOB_NAME} * " and got ... Running: Print Message * ${env.JOB_NAME} * ... ]

Hide

Permalink

Ronald Pomeroy added a comment - 2015-09-02 23:20 - edited

env.JOB_NAME (I assume) is static. If new branches are indexed (in the multibranch plugin case) how can the JOB_NAME contain the git branch name?

Am I missing something?

Regards

Ron

Show

Ronald Pomeroy added a comment - 2015-09-02 23:20 - edited env.JOB_NAME (I assume) is static. If new branches are indexed (in the multibranch plugin case) how can the JOB_NAME contain the git branch name? Am I missing something? Regards Ron

Hide

Permalink

Jesse Glick added a comment - 2015-09-04 21:04

Yes you are missing something. For example, in the stock CD demo (1.10), adding

echo "running from ${env.JOB_NAME.replaceFirst('.+/', '')}"

works (after approving method java.lang.String replaceFirst java.lang.String java.lang.String for the sandbox).

Show

Jesse Glick added a comment - 2015-09-04 21:04 Yes you are missing something. For example, in the stock CD demo (1.10), adding echo "running from ${env.JOB_NAME.replaceFirst( '.+/' , '')}" works (after approving method java.lang.String replaceFirst java.lang.String java.lang.String for the sandbox).

Jesse Glick made changes - 2015-09-17 13:55

Labels

multibranch

Jesse Glick made changes - 2015-09-29 12:58

Remote Link

This issue links to "Stack Overflow (Web Link)" [ 13165 ]

Jesse Glick made changes - 2015-10-01 19:27

Link

This issue is blocking ~~JENKINS-30744~~ [ ~~JENKINS-30744~~ ]

Hide

Permalink

magnayn added a comment - 2015-10-02 09:04 - edited

Ah. That explains why my workflow produces nulls in

node('docker') {
  
  checkout scm;

  echo "Build of ${env.GIT_COMMIT} on ${env.GIT_BRANCH}";

 // etc etc

Seems like SCM passing environment vars is going to be pretty important?

Show

magnayn added a comment - 2015-10-02 09:04 - edited Ah. That explains why my workflow produces nulls in node( 'docker' ) { checkout scm; echo "Build of ${env.GIT_COMMIT} on ${env.GIT_BRANCH}" ; // etc etc Seems like SCM passing environment vars is going to be pretty important?

Hide

Permalink

Jesse Glick added a comment - 2015-10-02 13:46

~~JENKINS-24141~~ tracks core changes needed to allow the Git plugin to define $GIT_COMMIT and the like. You can work around that particular variable using git rev-parse HEAD of course.

Show

Jesse Glick added a comment - 2015-10-02 13:46 JENKINS-24141 tracks core changes needed to allow the Git plugin to define $GIT_COMMIT and the like. You can work around that particular variable using git rev-parse HEAD of course.

Jesse Glick made changes - 2015-10-02 13:46

Link

This issue is related to ~~JENKINS-24141~~ [ ~~JENKINS-24141~~ ]

Hide

Permalink

Liel Ran added a comment - 2015-10-13 14:25

Jesse Glick - this workaround is now working for me (even inside SCM block). any other idea ?

Show

Liel Ran added a comment - 2015-10-13 14:25 Jesse Glick - this workaround is now working for me (even inside SCM block). any other idea ?

Hide

Permalink

Jesse Glick added a comment - 2015-10-13 17:06

Liel Ran not working for you, you mean? And what specifically is not working, in what way?

Show

Jesse Glick added a comment - 2015-10-13 17:06 Liel Ran not working for you, you mean? And what specifically is not working, in what way?

Jesse Glick made changes - 2015-11-02 20:45

Status

Open [ 1 ]

In Progress [ 3 ]

Jesse Glick made changes - 2015-11-02 21:28

Component/s		branch-api-plugin [ 18621 ]
Component/s	workflow-plugin [ 18820 ]

Jesse Glick made changes - 2015-11-02 21:28

Labels

multibranch

Jesse Glick made changes - 2015-11-02 21:40

Remote Link

This issue links to "PR 12 (Web Link)" [ 13403 ]

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-11-02 23:17

Code changed in jenkins
User: Jesse Glick
Path:
src/main/java/jenkins/branch/BranchNameContributor.java
src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.jelly
src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.properties
http://jenkins-ci.org/commit/branch-api-plugin/93e542c28b00cdb17a6251a43e8a61c3a6a8f710
Log:
[FIXED JENKINS-30252] Defining environment variable BRANCH_NAME.

Show

SCM/JIRA link daemon added a comment - 2015-11-02 23:17 Code changed in jenkins User: Jesse Glick Path: src/main/java/jenkins/branch/BranchNameContributor.java src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.jelly src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.properties http://jenkins-ci.org/commit/branch-api-plugin/93e542c28b00cdb17a6251a43e8a61c3a6a8f710 Log: [FIXED JENKINS-30252] Defining environment variable BRANCH_NAME.

SCM/JIRA link daemon made changes - 2015-11-02 23:17

Resolution		Fixed [ 1 ]
Status	In Progress [ 3 ]	Resolved [ 5 ]

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-11-02 23:17

Code changed in jenkins
User: Jesse Glick
Path:
src/main/java/jenkins/branch/BranchNameContributor.java
src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.jelly
src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.properties
http://jenkins-ci.org/commit/branch-api-plugin/4f02e07e44726dc4277e29907c1f8e10ee06da22
Log:
Merge pull request #12 from jglick/branch-name-~~JENKINS-30252~~

~~JENKINS-30252~~ Defining environment variable BRANCH_NAME

Compare: https://github.com/jenkinsci/branch-api-plugin/compare/b8f6a22a92fa...4f02e07e4472

Show

SCM/JIRA link daemon added a comment - 2015-11-02 23:17 Code changed in jenkins User: Jesse Glick Path: src/main/java/jenkins/branch/BranchNameContributor.java src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.jelly src/main/resources/jenkins/branch/BranchNameContributor/buildEnv.properties http://jenkins-ci.org/commit/branch-api-plugin/4f02e07e44726dc4277e29907c1f8e10ee06da22 Log: Merge pull request #12 from jglick/branch-name- JENKINS-30252 JENKINS-30252 Defining environment variable BRANCH_NAME Compare: https://github.com/jenkinsci/branch-api-plugin/compare/b8f6a22a92fa...4f02e07e4472

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-11-02 23:19

Code changed in jenkins
User: Jesse Glick
Path:
multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/BranchJobProperty.java
multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowBranchProjectFactory.java
multibranch/src/test/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowMultiBranchProjectTest.java
http://jenkins-ci.org/commit/workflow-plugin/7e91ca4f506e596f2abab4c1d45ca076fd30e2c4
Log:
~~JENKINS-30252~~ Verifying that ${env.BRANCH_NAME} works.
Also clarifying that BranchJobProperty.branch is nonnull, always.

Show

SCM/JIRA link daemon added a comment - 2015-11-02 23:19 Code changed in jenkins User: Jesse Glick Path: multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/BranchJobProperty.java multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowBranchProjectFactory.java multibranch/src/test/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowMultiBranchProjectTest.java http://jenkins-ci.org/commit/workflow-plugin/7e91ca4f506e596f2abab4c1d45ca076fd30e2c4 Log: JENKINS-30252 Verifying that ${env.BRANCH_NAME} works. Also clarifying that BranchJobProperty.branch is nonnull, always.

Hide

Permalink

SCM/JIRA link daemon added a comment - 2015-11-02 23:19

Code changed in jenkins
User: Jesse Glick
Path:
multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/BranchJobProperty.java
multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowBranchProjectFactory.java
multibranch/src/test/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowMultiBranchProjectTest.java
http://jenkins-ci.org/commit/workflow-plugin/8803a3e713d041cda74031829fa8b13a496642ae
Log:
Merge pull request #236 from jglick/branch-name-~~JENKINS-30252~~

~~JENKINS-30252~~ Verifying that ${env.BRANCH_NAME} works

Compare: https://github.com/jenkinsci/workflow-plugin/compare/85553288ab80...8803a3e713d0

Show

SCM/JIRA link daemon added a comment - 2015-11-02 23:19 Code changed in jenkins User: Jesse Glick Path: multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/BranchJobProperty.java multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowBranchProjectFactory.java multibranch/src/test/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowMultiBranchProjectTest.java http://jenkins-ci.org/commit/workflow-plugin/8803a3e713d041cda74031829fa8b13a496642ae Log: Merge pull request #236 from jglick/branch-name- JENKINS-30252 JENKINS-30252 Verifying that ${env.BRANCH_NAME} works Compare: https://github.com/jenkinsci/workflow-plugin/compare/85553288ab80...8803a3e713d0

Hide

Permalink

Marcus Sjölin added a comment - 2016-01-25 11:56 - edited

This feature seem to have gone into 1.11, however I cannot get this to work in 1.13

node {
        // Mark the code checkout 'stage'....
        stage 'Checkout'
        // Get some code from a GitHub repository
        checkout([$class: 'GitSCM', branches: [[name: 'develop'], [name: 'feature/*']], doGenerateSubmoduleConfigurations: false, submoduleCfg: [], userRemoteConfigs: [[credentialsId: '...', url: 'ssh://git@giturl']]])
        echo "${BRANCH_NAME} ${env.BRANCH_NAME}"
}

Show

Marcus Sjölin added a comment - 2016-01-25 11:56 - edited This feature seem to have gone into 1.11, however I cannot get this to work in 1.13 node { // Mark the code checkout 'stage' .... stage 'Checkout' // Get some code from a GitHub repository checkout([$class: 'GitSCM' , branches: [[name: 'develop' ], [name: 'feature/*' ]], doGenerateSubmoduleConfigurations: false , submoduleCfg: [], userRemoteConfigs: [[credentialsId: '...' , url: 'ssh: //git@giturl' ]]]) echo "${BRANCH_NAME} ${env.BRANCH_NAME}" }

Hide

Permalink

SCM/JIRA link daemon added a comment - 2016-04-05 20:30

Code changed in jenkins
User: Jesse Glick
Path:
multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/BranchJobProperty.java
multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowBranchProjectFactory.java
multibranch/src/test/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowMultiBranchProjectTest.java
http://jenkins-ci.org/commit/workflow-multibranch-plugin/05869c106e5dc5aadfab507673b7b888d7ae5584
Log:
~~JENKINS-30252~~ Verifying that ${env.BRANCH_NAME} works.
Also clarifying that BranchJobProperty.branch is nonnull, always.

Originally-Committed-As: 7e91ca4f506e596f2abab4c1d45ca076fd30e2c4

Show

SCM/JIRA link daemon added a comment - 2016-04-05 20:30 Code changed in jenkins User: Jesse Glick Path: multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/BranchJobProperty.java multibranch/src/main/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowBranchProjectFactory.java multibranch/src/test/java/org/jenkinsci/plugins/workflow/multibranch/WorkflowMultiBranchProjectTest.java http://jenkins-ci.org/commit/workflow-multibranch-plugin/05869c106e5dc5aadfab507673b7b888d7ae5584 Log: JENKINS-30252 Verifying that ${env.BRANCH_NAME} works. Also clarifying that BranchJobProperty.branch is nonnull, always. Originally-Committed-As: 7e91ca4f506e596f2abab4c1d45ca076fd30e2c4

Lars Meynberg made changes - 2016-05-02 14:16

Link

This issue is related to ~~JENKINS-32244~~ [ ~~JENKINS-32244~~ ]

R. Tyler Croy made changes - 2016-07-25 23:57

Workflow

JNJira [ 165345 ]

JNJira + In-Review [ 197691 ]

S L made changes - 2017-09-30 00:13

Link

This issue is related to JENKINS-47226 [ JENKINS-47226 ]

People

Assignee:: Jesse Glick

Reporter:: Ronald Pomeroy

Votes:: 0 Vote for this issue

Watchers:: 12 Start watching this issue

Dates

Created:: 2015-09-01 21:15

Updated:: 2017-09-30 00:13

Resolved:: 2015-11-02 23:17