FeaturizersLibrary/CI

Updating Build Information

Build information is updated in 1 of 2 ways, depending on which part of the version needs to be modified. Semantic Versioning terminology is used in the description that follows.

Example build number:                   <major>.<minor>.<patch>[-<prelease_build_name>][+<build info>]
Examples:                               1.2.3-preview.1         ==  1.2.3-preview.1+with.build.info
                                            < 1.2.3-preview.2   <   1.2.3-preview.11
                                            < 1.2.3-zulu        <   1.2.3

<major>, <minor>, and <patch> build values are defined in cmake files and should be updated there; for an example, see src/SharedLibrary/cmake/Featurizers.cmake.

<prerelease_build_name> and <build_info> are defined when invoking the CI build. Additional information (including steps to specify these values) follows.

Build Types

The yaml build definitions in this directory are able to create difference build types, each with different versioning, packaging, and publishing characteristics. Build variables specified when invoking CI.yaml on Azure DevOps are used to specific which build type is invoked.

All version numbers conform to Semantic Versioning standards*.

Continuous Integration / Standard Build

The build type invoked by default (when no Azure DevOps variables are specified).

Azure DevOps Variables:                 None
Version:                                <major>.<minor>.<patch>-cibuild.<year>.<month>.<day>.<hour>.<minute>.<second>.<debug|release>
Example:                                0.2.0-cibuild.2019.10.23.8.47.19.release
NuGet Store:                            https://aiinfra.visualstudio.com/DataPipelines/_packaging

Prerelease

An unofficial, but public, release.

Azure DevOps Variables:                             prerelease_build_name=<build_name>
Version:                                            <major>.<minor>.<patch>-<build_name>
Example (where prerelease_build_name=preview001):   0.2.0-preview001
NuGet Store:                                        https://www.nuget.org/

Release

An official release.

Azure DevOps Variables:                 release_build=True
Version:                                <major>.<minor>.<patch>
Example:                                0.2.0
NuGet Store:                            https://www.nuget.org

* Note that NuGet doesn't support SemVer's build info (e.g. "+<build info here>") well, which is why Continuous Integration datetime info is stored as prerelease info rather than build info.

Azure DevOps Configuration Settings

These Azure DevOps build definitions rely on the following Service Connections. To add/remove/view Service Connections within Azure DevOps:

1) Navigate to Azure DevOps Project Page
2) Project Settings -> Service connections

AI Infra Build

Used to push binaries to Azure resources during publish.

Type:                                               Azure Resource Manager
Connection Name:                                    AI Infra Build (<guid>)
Scope level:                                        Subscription
Subscription:                                       AI Infra Build (<guid>)
Resource Group:                                     FeaturizersBuild

ESRP CodeSigning Connection

Used to sign binaries and packages.

Type:                                               ESRP CodeSigning
Server URL:                                         https://api.esrp.microsoft.com/api/v2
AAD APP Id:                                         <created in Azure>
AAD APP Secret:                                     <created in Azure>
PRSS Signing Authentication Certificate:            Created through the [ESRP Portal](https://portal.esrp.microsoft.com/)

Nuget

Used to push NuGet packages.

Type:                                               NuGet Service Connection
Feed URL:                                           https://api.nuget.org/v3/index.json
ApiKey:                                             Created on NuGet.org and then copied to the Azure DevOps connection dialog window for one-tiem usage

featurizersbuild

Used to pull the universal_linux Docker image for universal_linux builds.

Type:                                               Dockerregistry
Registry Type:                                      Azure Container Registry
Connection name:                                    featurizersbuild
Azure subscription:                                 AI Infra Build
Azure container registry:                           featurizersbuild

Azure DevOps Settings

The Publish build will tag sources upon successful completion. To do this, the Azure DevOps Project Collection Build Service account needs contribute permissions to create tags for the appropriate repos. Follow the steps here to grant those permissions.