diff --git a/docs/releasing.md b/docs/releasing.md index e929bc2d..cb3fbe24 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -79,8 +79,69 @@ The pipeline will: ## Installer -The Azure Kinect SDK installer provides both open and closed source binaries. The open source binaries are built from +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 +[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 | 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.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/k4a_export.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/k4atypes.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/k4aversion.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/k4a.hpp | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/k4arecord_export.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/playback.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/record.h | :white_check_mark: | :white_check_mark: | | :white_check_mark: | +include/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.1.0 \* | | | :white_check_mark: | | +linux-ubuntu/x64/release/libk4a.so | | | :white_check_mark: | | +linux-ubuntu/x64/release/libk4a.so.1 | | | :white_check_mark: | | +linux-ubuntu/x64/release/libk4a.so.1.1.0 | | | :white_check_mark: | | +linux-ubuntu/x64/release/libk4arecord.so | | | :white_check_mark: | | +linux-ubuntu/x64/release/libk4arecord.so.1 | | | :white_check_mark: | | +linux-ubuntu/x64/release/libk4arecord.so.1.1.0 | | | :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/x64/release/depthengine_1_0.dl \* | :white_check_mark: | :white_check_mark: | | | +windows-desktop/x64/release/k4a.dll | :white_check_mark: | :white_check_mark: | | | +windows-desktop/x64/release/k4a.lib | :white_check_mark: | :white_check_mark: | | | +windows-desktop/x64/release/k4a.pdb | :white_check_mark: | :white_check_mark: | | | +windows-desktop/x64/release/k4arecord.dll | :white_check_mark: | :white_check_mark: | | | +windows-desktop/x64/release/k4arecord.lib | :white_check_mark: | :white_check_mark: | | | +windows-desktop/x64/release/k4arecord.pdb | :white_check_mark: | :white_check_mark: | | | +windows-desktop/tools/x64/release/AzureKinectFirmwareTool.exe | :white_check_mark: | | | | +windows-desktop/tools/x64/release/AzureKinectFirmwareTool.pdb | :white_check_mark: | | | | +windows-desktop/tools/x64/release/k4arecorder.exe | :white_check_mark: | | | | +windows-desktop/tools/x64/release/k4arecorder.pdb | :white_check_mark: | | | | +windows-desktop/tools/x64/release/k4aviewer.exe | :white_check_mark: | | | | +windows-desktop/tools/x64/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))