Software Releases
- administrator
- software
- releases
- versions
- semantic
- change requests
- devops
Configuration > Software Releases
Related Guides:
| Field | Type | Description |
| Setup Products | Button | Opens up the menu for creating and configuring Software Products. |
| Release Types | Button | Opens up the menu for creating and configuring Software Release Types. |
| Release Note Groups | Button | Opens up the menu for creating and configuring Software Release Note Groups. |
| Use Beta Release | Checkbox | When checked, tickets (such as change requests) can be tagged to a release that is classed as a 'Beta' release. |
| Beta Release Name | Free Text | When the use of Beta releases is enabled, here you can choose what field name is used for the field used to tag a ticket to a Beta release. The system, field 'Release' is used to assign a ticket to a release but here you can change the name of this field in the UI. |
| Use Candidate Release | Checkbox | When checked, tickets (such as change requests) can be tagged to a release that is classed as a 'Candidate' release. |
| Candidate Release Name | Free Text | When the use of Candidate releases is enabled, here you can choose what field name is used for the field used to tag a ticket to a Beta release. The system, field 'Release' is used to assign a ticket to a release but here you can change the name of this field in the UI. |
| Automatically tag notes from Beta releases which are not tagged against a Candidate release when releasing a new Candidate with a higher sequence | Checkbox | When enabled any tickets that are tagged to a Beta release will automatically be tagged to a candidate release when a candidate release of a higher sequence is created. The candidate release they are tagged to will depend on the 'Automatic Tagging Method (Candidate)' chosen. |
| Automatic Tagging Method (Candidate) | Single Select | This determines how tickets are automatically tagged to candidate releases. When 'Tag to the version being released' is selected the ticket will be tagged to the newest release in the 'Candidate release note set'. When 'Tag to the same version as the Beta tag' is selected the ticket will be tagged to the same version as the Beta release in the 'Candidate release note set'. |
| Use Stable Release | Checkbox | When checked, tickets (such as change requests) can be tagged to a release that is classed as a 'Stable' release. |
| Stable Release Name | Free Text | When the use of Candidate releases is enabled, here you can choose what field name is used for the field used to tag a ticket to a Beta release. The system, field 'Stable' is used to assign a ticket to a release but here you can change the name of this field in the UI. |
| Automatically tag notes from Beta and Candidate releases which are not tagged against a Stable release when releasing a new Stable with a higher sequence | Checkbox | When enabled any tickets that are tagged to a Beta or Candidate release will automatically be tagged to a Stable release when a Stable release of a higher sequence is created. The Stable release they are tagged to will depend on the 'Automatic Tagging Method (Stable)' chosen. |
| Automatic Tagging Method (Stable) | Single Select | This determines how tickets are automatically tagged to Stable releases. When' Tag to the version being released is selected the ticket will be tagged to the newest release in the 'Stable release note set'. When 'Tag to the same version as the Beta/Candidate tag' is selected the ticket will be tagged to the same version as the Beta/Candidate release in the 'Stable release note set'. |
| Category for Release Notes | Single Select | The category selected here will appear in the column profile when viewing the release notes against a version. This allows you to categorise software release notes/change requests further, adding this category value to the overarching view. |
| Include unsent release notes from previous versions in Release emails | Checkbox | When disabled release emails will only be sent to the end users against release notes assigned to the release the email is being sent from. If enabled all these users, plus users against release notes in previous releases that have not been released yet, will be sent the release email (only where the product against the ticket matches). In short, this can be enabled to ensure any older releases that have not been released officially have release email sent out. |
| Use Semantic Versioning | Checkbox | When enabled you will be able to name releases using a strict semantic format (e.g. 2.9.1) |
| Restrict the list of versions that appear in the version field if the version is not released | Checkbox | When enabled only versions that have been release will be available to select in the 'Version' field (this field is used to link incidents to releases). A version is classed as released when the release date has passed. |
| When selecting a release, choose from any that are linked to products that are linked to the same DevOps project | Checkbox | When enabled, you will be able to select any releases for the product associated with the ticket as well as any releases associated with the product linked to the ticket via a third party. When the ticket is linked to a third party entity (such as an issue in Jira), you will be able to choose from releases associated with the third party product as well as the ones for the product linked to the Halo ticket. |
| Exclude the unknown version from the version list | Checkbox | When enabled, the 'unknown' version will not be able to be selected in the 'version' field. The version field is used to link incident tickets to releases. |
Setup Products
| Field | Type | Description |
| Product Name | Free Text | This will be the name of the Product as it appears elsewhere throughout the system. |
| Components | List | Components that are part of this Product can be added to this list, and are purely descriptive with a free text name only. |
| Release Emails | Button | When creating a new release email, you will have an option to apply an email template per release type, per product. Child tickets can be emailed and you can change the ticket status after the email is sent. |
| Releases | List | This list will detail any software releases related to this product. |
Release Types
| Field | Type | Description |
| Release Type Description | Free Text | This will be the name of this Release Type as it appears elsewhere throughout the system. |
| Release Note Set | Single Select | This allows the selection of the Release Note associated with this Release Type. |
Release Note Groups
| Field | Type | Description |
| Name | Free Text | This will be the name of the Release Note Group as it appears elsewhere throughout the system. |
| Release Note | Free Text | Here enter a note for the release note group. |