X++ model-versioning in Azure Pipelines

During build automation, X++ model versions can be updated so that they match or are linked to the build number of the pipeline. These updates make it easier for customers to identify the version of the X++ packages that they are running. They also let developers track versions back to the build pipeline and the version of the source code files.

This article assumes a working knowledge of Azure Pipelines.

Note

Before you can add these steps to a pipeline, the Dynamics 365 finance and operations Tools extension for Azure DevOps must be enabled and installed in the Azure DevOps account. For more information about how to install an extension for an organization, see Install extensions.

Add the task to a pipeline

To add the task to the build of your YML or Classic pipeline, search the task list for Update Model Version. The following table describes the options that are available for this task.

Input name	Mandatory	Description
X++ Source Location	Yes	The path of a parent folder that contains X++ source code. The Descriptor Search Pattern option will be run in this path and subfolders. The default value, $(Build.SourcesDirectory), points to the root of the source code repository.
Descriptor Search Pattern	Yes	Provide a file matching pattern to find the descriptor files inside the path that is specified in the X++ Source Location option. You can also specify a list of full paths of descriptor files instead of search patterns. For more information, see File matching patterns reference.
Lowest Layer to Update	Yes	When using search patterns, this task may find descriptors for ISV or partner code in your source control. Those descriptor versions should likely not be updated. This option allows you to define an additional filter to define the lowest layer that the task will update.
Version number in format #.#.#.# to update	Yes	The version number to write into the descriptors. Note that the format must consist of four digits that are separated by periods (.). By using the build ID or build number, you allow for traceability. Note that the default build number isn't in the correct format. You can change the format in the classic editor, under Options > Build number format. You can also change it by adding a name: tag at the top of the YML file. An example of a valid build number that uses the year, month, and date, and also the build count revision number, is $(Date:yy.MM.dd)$(Rev:.r). For more information, see Configure run or build numbers.