# build-name-setter-plugin

**Repository Path**: mamh-java/build-name-setter-plugin

## Basic Information

- **Project Name**: build-name-setter-plugin
- **Description**: https://github.com/mamh-java/build-name-setter-plugin
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-14
- **Last Updated**: 2024-07-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Build Status](https://ci.jenkins.io/job/Plugins/job/build-name-setter-plugin/job/master/badge/icon)](https://ci.jenkins.io/job/Plugins/job/build-name-setter-plugin/job/master/)
[![Build status](https://ci.appveyor.com/api/projects/status/niut5mwbxdnht3pt/branch/master?svg=true)](https://ci.appveyor.com/project/damianszczepanik/build-name-setter-plugin/branch/master)

[![Popularity](https://img.shields.io/jenkins/plugin/i/build-name-setter.svg)](https://plugins.jenkins.io/build-name-setter)

# Build name setter plugin for Jenkins

This plugin sets the display name of a build to something other than #1, #2, #3, ... so that you can use an identifier
that makes more sense in your context. When you install this plugin, your job configuration page gets additional setting
that lets you specify a build name for each new build.

This plugin can be used in two ways:

* Set build name at the begining and at the end of the build (both by default, it also can be ajusted)

![alt tag](./.README/Screenshot_build_env.png)

* Set build name between two build steps (as a separate build step)

![alt tag](./.README/Screenshot_build_step.png)

As the result you can obtain something like this:

![alt tag](./.README/Screenshot_build_name.png)

# Pipeline
This is how the plugin can be used via pipeline approach. Name and the description can be changed like any other steps.
Mind that there are a few conventions which can be used to modify name or description:
```groovy
pipeline {
    agent any
    stages {
        stage("Initialization") {
            steps {
                // use name of the patchset as the build name
                buildName "${GERRIT_CHANGE_SUBJECT}"
                buildDescription "Executed @ ${NODE_NAME}"
            }
        }
    }
    post {
        failure {
            // in case of failure, we'd like to have simple 'git blame' on build history :)
            currentBuild.displayName = 'This build needs help!!!'
            buildDescription("Committer: ${GERRIT_PATCHSET_UPLOADER_NAME}")
        }
    }
}
```

# Scripting
The power of this plugin is based on [Macro Token](https://wiki.jenkins.io/display/JENKINS/Token+Macro+Plugin) so take a look what features you can use.