Jenkins – How to disable branch in Multibranch pipeline with Jenkinsfile

Jenkinsjenkins-pipelinemultibranch-pipeline

I have a Multi branch pipeline project in Jenkins. I want to disable a branch while it is listed in pipeline project. I can add an exception to surpass scm triggering. But I want to disable all the triggering including manual triggering. If I used "Disable this project" under "Build triggers" in job created for a branch, that option is not selected when I reload the page(There are no save/apply buttons which is available for single branch pipelines). It only keeps follwing configuration that was configured in Jenkinsfile.

pipelineTriggers([
    snapshotDependencies(),
]),

Are there any way to specify "Disable this project" in Jenkinsfile

Best Answer

True, you cannot disable the project from Jenkins Job as multibranch pipeline doesn't give control to change the settings from the job.

Two ways to stop your branch from building.

1) Disable the Branch

To get control of the settings, go to PROJECT(project you want to modify the settings) > Configure > Projects( enable advanced settings)

Enter the branch in "Exclude branch" and save the settings.

2) Rename Jenkinsfile

If you don't have control of the project settings, the easy way is to rename the Jenkinsfile in the project/branch.

This configuration will define to trigger a build if a branch/project has "Jenkinsfile" in it. Hence, renaming it will not trigger a build.

Hope this helps..

UPDATE : AFAIK, you can't disable the project from Jenkisfile, but as workaround you can configure the cronjob as follows:

properties([pipelineTriggers([cron('')])])

If configuration is not available in cron, the build will not trigger at all.

Related Solutions

Jenkins – Multibranch Pipeline vs Pipeline job

In my experience with multibranch pipelines, the ONLY downside is that you can't see the last success/failure/duration columns on the Jenkins main page. They just show "NA" on the Jenkins front page since it's technically a 'folder' of sub-jobs.

Other than that I can't think of any other "cons" to using multibranch.

I disagree with the other answer.... that case was that multibranch sends changes for "any" branch. That's not necessarily true. If a Jenkinsfile exists on a random feature branch, but that branch is not defined in the pipeline then you can just not do anything with it using typical if/else conditionals.

For example:

node {
  checkout scm
  def workspace = pwd()

  if (env.BRANCH_NAME == 'master') {
    stage ('Some Stage 1 for master') {
      sh 'do something'
    }
    stage ('Another Stage for Master') {
      sh 'do something else here'
    }
  }

  else if (env.BRANCH_NAME == 'stage') {
    stage ('Some stage branch step') {
      sh 'do something'
    }
    stage ('Deploy to stage target') {
      sh 'do something else'
    }
  }

  else {
    sh 'echo "Branch not applicable to Jenkins... do nothing"'
  }
}

Git – How to trigger Jenkins Multi-Branch Pipeline with Gitlab Webhook

You need to install Gitlab Plugin on Jenkins.

This will add a /project endpoint on Jenkins. (See it in Jenkins => Administrate Jenkins => Configure System => Gitlab )

Now add a webhook on your Gitlab project => Settings => Integrations. (or in older Gitlab version : Gitlab project => Wheel icon => Integrations, it seems you need to be owner of project in this case)

In Url : set http://*yourjenkins.com*/**project**(/*foldername*)?/*yourprojectname* and that's all, and click on "Add Webhook".

When you click on test on your webhook, it should trigger your jenkins pipeline build. (You should have a 200 http response)

It works without authentication in Gitlab plugin, configuration with authentication are welcome.

Best Answer

Related Solutions

Jenkins – Multibranch Pipeline vs Pipeline job

Git – How to trigger Jenkins Multi-Branch Pipeline with Gitlab Webhook

Related Topic