148 lines
12 KiB
Markdown
148 lines
12 KiB
Markdown
|
# Release Process
|
||
|
|
|
||
|
|
The release process and building of private binaries is managed by Microsoft Azure Kinect team members.
|
||
|
|
|
||
|
|
Released builds are numbered using semantic versioning. The GitHub project and CI builds are not uniquely versioned.
|
||
|
|
Versioning is applied by the private Azure Kinect Packing build system.
|
||
|
|
|
||
|
|
The packaging build system may produce multiple builds with the same build number e.g. "1.0.1-beta.0", however only
|
||
|
|
one build of that number will ever be distributed internally or externally for validation or release.
|
||
|
|
|
||
|
|
Releases are scheduled on demand based on program needs.
|
||
|
|
|
||
|
|
## Release Types
|
||
|
|
|
||
|
|
### Alpha Release
|
||
|
|
|
||
|
|
Alpha builds are built using source from the develop branch and are numbered with the
|
||
|
|
expected release number for current development, such as `1.1.0-alpha.0`.
|
||
|
|
|
||
|
|
Alpha builds expect heavy churn and are not guaranteed to be backward compatible with each other.
|
||
|
|
|
||
|
|
### Beta Release
|
||
|
|
|
||
|
|
Beta builds are built from the release branches, such as `1.1.0-beta.0`.
|
||
|
|
|
||
|
|
Release branches are created when that release is being stabilized, at which point only bug fixes and changes
|
||
|
|
required for that release are merged or cherry-picked in to the release branch. Fixes may alternatively be made
|
||
|
|
to the release branch directly and then merged back to the develop branch.
|
||
|
|
|
||
|
|
### Official Release
|
||
|
|
|
||
|
|
Once a beta build has been signed off for release, an official build is created with code from that release branch,
|
||
|
|
such as `1.1.0`
|
||
|
|
|
||
|
|
### Patch releases
|
||
|
|
|
||
|
|
Critical changes to a released build may be made in the release branch to patch an existing release. These
|
||
|
|
changes do not introduce functionality or break compatibility.
|
||
|
|
|
||
|
|
Changes are made in the release branch for the existing release, such as `release/1.0.x`, and are verified with beta
|
||
|
|
builds for the patch, such as `1.0.1-beta.0`, before the patch is signed off and released as `1.0.1`
|
||
|
|
|
||
|
|
## Moving changes between release branches
|
||
|
|
|
||
|
|
When a release branch is created it should be created from the develop branch.
|
||
|
|
|
||
|
|
Changes may be merged (not squashed) from develop in to a release branch so long as there are no new
|
||
|
|
changes in develop not suitable for that release.
|
||
|
|
|
||
|
|
Once develop starts taking changes for the next release, changes must be cherry-picked or made
|
||
|
|
directly in a release branch.
|
||
|
|
|
||
|
|
Release branches should always be merged back in to develop (not squashed) after changes have been made
|
||
|
|
there to avoid future merge conflicts.
|
||
|
|
|
||
|
|
Our Github repository policy enforces that all pull requests are squashed. Therefore merges between
|
||
|
|
release branches should be done locally, and the results pushed by a repository administrator.
|
||
|
|
|
||
|
|
## Building a Release Package
|
||
|
|
|
||
|
|
The Azure Kinect team will update the packaging build repository to reference the commit of the GitHub
|
||
|
|
Azure Kinect Sensor SDK repository to be released.
|
||
|
|
The Azure Kinect team will schedule an official build of the packaging repository with the correct
|
||
|
|
release version number.
|
||
|
|
|
||
|
|
The build will produce an official copy of the SDK with the depth engine and installer. All binaries
|
||
|
|
are signed and the symbols are indexed.
|
||
|
|
|
||
|
|
Once a candidate build has been produced, it can be submitted to the Azure Kinect Release pipeline.
|
||
|
|
|
||
|
|
The pipeline will:
|
||
|
|
|
||
|
|
* Run all release tests.
|
||
|
|
* Request manual sign off validation.
|
||
|
|
* Update the documentation resources.
|
||
|
|
* Tag commit in the Azure Kinect Sensor SDK repository.
|
||
|
|
* Publish NuGet feeds.
|
||
|
|
* Request publishing of the MSI installer to the web.
|
||
|
|
|
||
|
|
## Installer
|
||
|
|
|
||
|
|
The Azure Kinect SDK installer provides both open and closed source binaries. The open source binaries are built from
|
||
|
|
this [GitHub repo](https://github.com/Microsoft/Azure-Kinect-Sensor-SDK).
|
||
|
|
|
||
|
|
[Release tags](https://github.com/Microsoft/Azure-Kinect-Sensor-SDK/releases) are used by Microsoft to label commits
|
||
|
|
used to create a released build. Checkout the commit that matches the release label to build the desired release version.
|
||
|
|
|
||
|
|
## Artifacts and Packaging
|
||
|
|
The following table contains all artifacts that are released in installers and packages. The file paths listed in the table are only representative, within any given package they will be different to match the standards and conventions for those packages. Each unique released artifact is listed in this table only once, although they will potentially appear duplicate times in packages or installers.
|
||
|
|
|
||
|
|
File | MSI/Installer | NuGet | Runtime Debian Package | Development Debian Package | Tooling Debian Package
|
||
|
|
-------------------------------------------------------------- | ------------------ | ------------------ | ------------------ | ------------------ | -----------------
|
||
|
|
LICENSE.txt \* | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
|
||
|
|
REDIST.txt \* | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
|
||
|
|
ThirdPartyNotices.txt \* | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
|
||
|
|
version.txt \* | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark: | :white_check_mark:
|
||
|
|
build/msbuild/native/Microsoft.Azure.Kinect.Sensor.targets \* | :one: | :white_check_mark: | | |
|
||
|
|
build/msbuild/netstandard2.0/Microsoft.Azure.Kinect.Sensor.targets \* | :two: | :two: | | |
|
||
|
|
build/cmake/x64/k4aConfig.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
build/cmake/x64/k4aConfigVersion.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
build/cmake/x64/k4aTargets-relwithdebinfo.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
build/cmake/x64/k4aTargets.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
build/cmake/x64/k4arecordConfig.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
build/cmake/x64/k4arecordConfigVersion.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
build/cmake/x64/k4arecordTargets-relwithdebinfo.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
build/cmake/x64/k4arecordTargets.cmake | :one: | :one: | | :white_check_mark: |
|
||
|
|
include/k4a/k4a.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4a/k4a.hpp | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4a/k4a_export.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4a/k4atypes.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4a/k4aversion.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4arecord/k4arecord_export.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4arecord/playback.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4arecord/record.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
include/k4arecord/types.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: |
|
||
|
|
linux-ubuntu/x64/release/libdepthengine.so \* | | | :white_check_mark: | |
|
||
|
|
linux-ubuntu/x64/release/libdepthengine.so.2.0 \* | | | :white_check_mark: | |
|
||
|
|
linux-ubuntu/x64/release/libk4a.so (symlink) | | | | :white_check_mark: |
|
||
|
|
linux-ubuntu/x64/release/libk4a.so.1.x (symlink) | | | :white_check_mark: | |
|
||
|
|
linux-ubuntu/x64/release/libk4a.so.1.x.x | | | :white_check_mark: | |
|
||
|
|
linux-ubuntu/x64/release/libk4arecord.so (symlink) | | | | :white_check_mark: |
|
||
|
|
linux-ubuntu/x64/release/libk4arecord.so.1.x (symlink) | | | :white_check_mark: | |
|
||
|
|
linux-ubuntu/x64/release/libk4arecord.so.1.x.x | | | :white_check_mark: | |
|
||
|
|
linux-ubuntu/tools/x64/release/AzureKinectFirmwareTool | | | | | :white_check_mark:
|
||
|
|
linux-ubuntu/tools/x64/release/k4arecorder | | | | | :white_check_mark:
|
||
|
|
linux-ubuntu/tools/x64/release/k4aviewer | | | | | :white_check_mark:
|
||
|
|
netstandard2.0/AnyCpu/release/Microsoft.AzureKinect.deps.json | :two: | :two: | | |
|
||
|
|
netstandard2.0/AnyCpu/release/Microsoft.AzureKinect.dll | :two: | :two: | | |
|
||
|
|
netstandard2.0/AnyCpu/release/Microsoft.AzureKinect.pdb | :two: | :two: | | |
|
||
|
|
netstandard2.0/AnyCpu/release/Microsoft.AzureKinect.xml | :two: | :two: | | |
|
||
|
|
windows-desktop/amd64/release/depthengine_2_0.dll \* | :white_check_mark: | :white_check_mark: | | |
|
||
|
|
windows-desktop/amd64/release/k4a.dll | :white_check_mark: | :white_check_mark: | | |
|
||
|
|
windows-desktop/amd64/release/k4a.lib | :white_check_mark: | :white_check_mark: | | |
|
||
|
|
windows-desktop/amd64/release/k4a.pdb | :white_check_mark: | :white_check_mark: | | |
|
||
|
|
windows-desktop/amd64/release/k4arecord.dll | :white_check_mark: | :white_check_mark: | | |
|
||
|
|
windows-desktop/amd64/release/k4arecord.lib | :white_check_mark: | :white_check_mark: | | |
|
||
|
|
windows-desktop/amd64/release/k4arecord.pdb | :white_check_mark: | :white_check_mark: | | |
|
||
|
|
windows-desktop/tools/amd64/release/AzureKinectFirmwareTool.exe | :white_check_mark: | | | |
|
||
|
|
windows-desktop/tools/amd64/release/AzureKinectFirmwareTool.pdb | :white_check_mark: | | | |
|
||
|
|
windows-desktop/tools/amd64/release/k4arecorder.exe | :white_check_mark: | | | |
|
||
|
|
windows-desktop/tools/amd64/release/k4arecorder.pdb | :white_check_mark: | | | |
|
||
|
|
windows-desktop/tools/amd64/release/k4aviewer.exe | :white_check_mark: | | | |
|
||
|
|
windows-desktop/tools/amd64/release/k4aviewer.pdb | :white_check_mark: | | | |
|
||
|
|
|
||
|
|
* \* These files are generated/included at packaging time from Microsoft Internal sources.
|
||
|
|
* :one: Include CMake and MS Build files in the MSI (issue [#370](https://github.com/microsoft/Azure-Kinect-Sensor-SDK/issues/370))
|
||
|
|
* :two: .NET support planned for a future release (issue [#136](https://github.com/microsoft/Azure-Kinect-Sensor-SDK/issues/136))
|