{"id":34430,"date":"2016-05-23T14:59:25","date_gmt":"2016-05-23T09:29:25","guid":{"rendered":"http:\/\/www.tothenew.com\/blog\/?p=34430"},"modified":"2016-05-25T11:34:36","modified_gmt":"2016-05-25T06:04:36","slug":"setting-dynamic-project-description-and-build-description-in-jenkins","status":"publish","type":"post","link":"https:\/\/www.tothenew.com\/blog\/setting-dynamic-project-description-and-build-description-in-jenkins\/","title":{"rendered":"Setting Dynamic Project Description and Build Description in Jenkins"},"content":{"rendered":"

Jenkins is an open source tool designed to achieve continuous integration<\/a> and continuous deployment.\u00a0I came across a scenario where I have to show custom results after every build run in Jenkins.\u00a0The build result produces dynamic values which are important to be identified before running the next build. For instance, I was creating a Jenkins job to create tags to the git repositories.<\/p>\n

The job produces a tag based on the choice made by the user. The choice accepts either ‘Major’, ‘Minor’ or ‘Fixed’ change . Based on the choice made, the job produces new tag. For example, if the current tag is\u00a04.0.0.\u00a0<\/strong>The new tag will be\u00a05.0.0\u00a0<\/strong>if the choice made is ‘Major’,\u00a04.1.0\u00a0<\/strong>if the choice made is minor and\u00a04.0.1\u00a0<\/strong>if the choice made is fixed. In a team, where a large number of people contribute and anyone can trigger the build to create the\u00a0tag, it is necessary to know the value of the\u00a0latest tag and the tags generated at various build results.<\/p>\n

I made use of\u00a0Dynamic Project Description\u00a0<\/strong>to show the value of the\u00a0latest tag and\u00a0Dynamic Build Description\u00a0<\/strong> to show the value of the tag generated at various build results. Jenkins uses various plugins to provide additional functionality to the users. Thus, we will make use of different plugins to use this feature.<\/p>\n

Setting up Project Description<\/span><\/h3>\n

We will make use of\u00a0Project Description Setter Plugin\u00a0<\/strong>to set the project description after every build result. The file description is set using a file in the workspace. To set the description, follow the below steps:<\/p>\n

    \n
  1. Go to\u00a0Manage Jenkins\u00a0<\/strong>option in Jenkins Console.<\/li>\n
  2. Under ‘Manage Jenkins’, click on\u00a0Manage Plugins\u00a0<\/strong>option.<\/li>\n
  3. Install\u00a0Project Description Setter Plugin.<\/strong><\/li>\n
  4. After installing the plugin, configure your job. Go to your Jenkins job and click on\u00a0Configure.<\/strong><\/li>\n
  5. Go under\u00a0Build Environment\u00a0<\/strong>and check on ‘Set a project description from a file in the workspace’.<\/li>\n
  6. The file must be present in the workspace. The content of the file may include Token Macros\u00a0<\/b>which will be expanded while setting up the description.<\/li>\n<\/ol>\n

    The different kind of available tokens which can be used to set description are:<\/p>\n

      \n
    • GIT_BRANCH :\u00a0<\/strong>it will be expanded to the branch name that was built. The ${GIT_BRANCH} variable wherever present in the file will be evaluated to its value.<\/li>\n
    • GIT_REVISION: <\/strong>It expands to the Git SHA1 commit ID that points to the commit that was built. It includes different parameters which could be used.<\/li>\n
    • BUILD_CAUSE:\u00a0<\/strong>It will display the cause of the build.<\/li>\n
    • BUILD_LOG_EXCERPT:\u00a0<\/strong>It is used to display a short extract from the build logs. You can use regex to filter the logs from starting or end.<\/li>\n
    • BUILD_LOG:\u00a0<\/strong>It is used to display the end lines of the\u00a0build log.<\/li>\n
    • BUILD_ NUMBER:\u00a0<\/b>It is used to display the build number of the build.<\/li>\n
    • BUILD_STATUS:\u00a0<\/b>It is used to display the status of build e.g. failed, unstable or success etc.<\/li>\n
    • JOB_DESCRIPTION:<\/strong> It will display the Job Description.<\/li>\n
    • {FILE,path=”PATH”}:\u00a0<\/strong>It expands to the contents of a file. The\u00a0PATH<\/strong> is relative to the workspace of the job.<\/li>\n
    • PROJECT_NAME:\u00a0<\/strong>It will display the Project name at Project Description.<\/li>\n<\/ul>\n

      There are many other options which are available to get the project description. The following is the file content which I have used to set the description:<\/p>\n

      ${BUILD_LOG_REGEX,regex=\"The Latest Tag is (.*)\",showTruncatedLines=false}<\/pre>\n
      The build log contains a\u00a0line for example, ” The Latest Tag is v1.1.1.” So the project description will be set to this line.<\/p>\n
       <\/p>\n
      \"Jenkins\"<\/p>\n
       <\/p>\n
      Setting up Build Description<\/span><\/h3>\n
      We have learnt how to set up Project<\/strong>\u00a0Description.<\/strong> Now we will study how to set up Build Description in Jenkins. The build description can be set by the following steps:<\/p>\n
        \n
      1. \u00a0Go to\u00a0Manage Jenkins\u00a0<\/strong>option in Jenkins Console.<\/li>\n
      2. Under ‘Manage Jenkins’, click on\u00a0Manage Plugins\u00a0<\/strong>option.<\/li>\n
      3. Install\u00a0description setter<\/strong>\u00a0Plugin.<\/strong><\/li>\n
      4. After the plugin is installed, configure your job. Go to your Jenkins job and go to Post-build actions.<\/strong><\/li>\n
      5. Click on\u00a0Set build description.<\/strong><\/li>\n
      6. The new functionality will be setup as shown below:<\/li>\n<\/ol>\n
        \"Jenkins\"<\/p>\n
        The Build Description will be set up for each build based on the regular expression. Enter the regular expression to set the description. The\u00a0Description\u00a0<\/strong>can be set for the build. The Regular expression can also be setup for failed builds. Here I have setup the description to\u00a0Failed\u00a0<\/strong>for failed jobs. Thus, the description will be set\u00a0Failed\u00a0<\/strong>whenever the build is failed.<\/p>\n
        The given below is the example of setting\u00a0Dynamic Build Description\u00a0<\/strong>in\u00a0Jenkins:<\/strong><\/p>\n
        \"Jenkins_failed\"<\/p>\n
        I will write more blogs on more\u00a0Advanced Techniques\u00a0<\/strong>on Jenkins. This blog has introduced how to set\u00a0Dynamic Project and Build Description\u00a0<\/strong>in\u00a0Jenkins.<\/strong><\/p>\n","protected":false},"excerpt":{"rendered":"
        Jenkins is an open source tool designed to achieve continuous integration and continuous deployment.\u00a0I came across a scenario where I have to show custom results after every build run in Jenkins.\u00a0The build result produces dynamic values which are important to be identified before running the next build. For instance, I was creating a Jenkins job […]<\/p>\n","protected":false},"author":163,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":370},"categories":[1174,2348],"tags":[3374,3373,3372,3376,3375,3378,3377],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/34430"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/163"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=34430"}],"version-history":[{"count":0,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/34430\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=34430"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=34430"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=34430"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}