Naming versions for deployment releases

Creating and configuring a deployment project

On this page

Still need help?

The Atlassian Community is here for you.

Ask the community

Bamboo provides a range of options that allow you to control your release naming scheme. You can specify how Bamboo handles release versioning, and control automatic incrementing between releases.

Bamboo allows you to use:

  • Simple incremental numbering 
  • Advanced numbering based upon Bamboo variables

Bamboo also allows you to manually override automatic release settings when you create a new release.

On this page:

Simple release versioning

Simple release versioning allows you to specify a starting release number, for example, 1.0, which Bamboo will automatically increment. When using simple release versioning, Bamboo will increment the final number in the release name. For example:

Release name Incremented release name
1 2
1.1 1.2
1.11 1.12
1.0.1 1.0.2


To configure simple release naming:

  1. Click the Release versioning button on the 'Deployment project configuration' screen to display the 'Release versioning' screen:

  2. Complete the 'Release versioning' screen using the following fields:

    Field
    Description
    Optional?
    Next release The identification for the next release name that Bamboo will create. In simple release naming, you should use something straightforward like 1.0. (error)
    If you want the naming scheme for the release to be applied to branches, select 'Apply the same naming scheme to versions create from branches'.
    (tick)
    Automatically increment with each new release Check the 'Numbers' checkbox to automatically increment the release number according to the 'Next release' field, as defined above. If you leave this box unchecked, no release number incrementing will occur. (tick)
    Preview

    This field allows you to preview what the next release name will look like. To view the preview, click on the Generate preview button next to the 'Create release name' field.

    Note: In some cases, a preview may not be available.

    -
  3. Click Save to save your changes.

Release versioning using variables

Release versioning using variables allows you to develop more complex naming schemes, based upon variables set up within Bamboo. You can use global, plan and build variables in your releasing scheme.

For security reasons, you can't use password variables in version names.


Example

You may have a plan variable called 'planvar' with a value of 'm6'. By including this variable key within the 'Next release' field, Bamboo will automatically add the variable value to the next release name, and increment it accordingly:

Variable key Variable balue Next release Next release version Subsequent Release version
planvar m6 1.0-${bamboo.planvar} 1.0-m6 1.1-m7


To configure release naming using variables:

  1. Click the Release versioning button on the 'Deployment project configuration' screen to display the 'Release naming' screen:
  2. Complete the 'Create release name' field using the following data:

    Field
    Description
    Optional?
    Version The identification for the next release name that Bamboo will create. In simple release versioning, you should use something straightforward like 1.0. (error)
  3. Click on the Add variable to release name link to display the Variables selection screen:
  4. Click Add variable to include the variable in your release naming scheme. Click on Close to return to the 'Release naming' screen
  5. Complete the 'Release name' field using the following fields:

    Field
    Description
    Optional?
    Automatically increment with each new release 1.Check the 'Numbers' checkbox to automatically increment the release number according to the 'Next release' field, as defined above. If you leave this box unchecked, then no release number incrementing will occur.
    2. Check the 'Variables' checkbox to automatically increment selected variable(s) when a new release is created.  If matching plan variable exists, its value is incremented, otherwise matching global variable is incremented. Additionally, if a release is created from a branch while 'Apply the same naming scheme to versions create from branches' option is on, the branch variable is incremented (as long as it exists)
    (tick)
    Preview

    This field allows you to preview what the next release name will look like. To view the preview, click on the Generate preview button next to the 'Create release name' field.

    Note: In some cases, a preview may not be available.

    -
  6. Click Save to save your changes.

Example release versioning schemes

Bamboo also allows you to use combinations of simple and variable release naming. The following table provides examples of combined naming schemes and demonstrates how careful control of the Numbers and Variables checkboxes can be used to customize your scheme.

Naming scheme Next release field Numbers checkbox Variables checkbox Variable value Next release name Subsequent release name
Static naming 1.0 (error) (error) - 1.0 1.0
Naturally unique variable 1.0-${bamboo.buildNumber} (error) (error) 13 1.0-13 1.0-13
Number incrementing 1.0 (tick) (error) - 1.0 1.1
Number incrementing + static variable 1.0-${bamboo.appName} (tick) (error)

$ {bamboo.appName}

Plan or Global variable: Awesome

1.0-Awesome 1.1-Awesome
Variable incrementing 1.0-${bamboo.milestone} (error) (tick)

$ {bamboo.milestone}

Plan or Global variable: m6

1.0-m6 1.0-m7
Number and variable incrementing 1.0-b${bamboo.appNumber} (tick) (tick)

${bamboo.appNumber}

User defined variable: 1567

1.0-b1567 1.1-b1568
Last modified on Aug 13, 2018

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.