# Release Process Adopt this skill: https://proskills.md/skills/other/microsoft-directxmesh-github-skills-release Page: https://proskills.md/skills/other/microsoft-directxmesh-github-skills-release This document is the public skill bundle for that page. It contains SKILL.md and every helper file the catalog carries. No login is required. ## File: .github/skills/release/SKILL.md size: 5540 upstream: https://github.com/microsoft/directxmesh/blob/main/.github/skills/release/SKILL.md ```text --- name: Release Process description: Guide for performing the DirectXMesh release process. Use this skill when asked to help with releasing a new version, publishing packages, or updating ports. --- # Release Process ## Prerequisites - All changes merged into the `main` branch with all tests passing. - GPG signing configured for your GitHub account (for verified tags). - Access to the MSCodeHub mirror repository and Azure DevOps pipelines. - Local repositories: - VCPKG at `d:\vcpkg` (synced with `main` branch) - WinGet at `D:\winget-pkgs` (synced with `master` branch, only if tool updates needed) - PATs will be needed for scripts that access GitHub and ADO. ## Steps ### Phase 1: Prepare Release 1. Git pull the local repository to ensure it is up to date with the `main` branch. 2. Run the PowerShell script `build\preparerelease.ps1` which will generate a topic branch for the release, update the version number in `CMakeLists.txt`, the `README.md` file, the release notes in the nuspec files, and create a stub in the `CHANGELOG.md` file for the new release. 3. Edit the `CHANGELOG.md` file to update it with a summary of changes. 4. Submit the topic branch for review and merge into `main` once approved. Allow the GitHub Actions workflows and the Azure DevOps pipelines to complete successfully before proceeding. ### Phase 2: Tag and Create GitHub Release 5. Run the PowerShell script `build\completerelease.ps1` which will set a tag on the project repo and the test repo, and create a release on GitHub with the release notes from `CHANGELOG.md`. Ensure you have set up GPG signing for your GitHub account so that the tags will be verified. 6. Git pull the local repository to ensure it is up to date with the `main` branch. Be sure to include `--tags`. ### Phase 3: MSCodeHub and Signed Binaries 7. Push the `main` branch to the MSCodeHub mirror repository. Be sure to include `--tags`. 8. Create a PR on MSCodeHub from the `main` branch to the `release` branch. 9. Merge the PR on MSCodeHub to update the release branch, which will trigger the Azure DevOps pipeline to build signed binaries and the NuGet packages. 10. Run the PowerShell script `build\downloadbuild.ps1` to download the signed binaries from the Azure DevOps pipeline artifacts. 11. Edit the GitHub release and upload the signed binaries to the release assets. ### Phase 4: Source Archive Signing 12. Download the GitHub source .zip archive from the release. Unzip and compare to the local repo to ensure it matches — keep in mind there may be some CR/LF differences. 13. Run minisign on the .zip to generate a signature file, and upload the signature file to the release assets. ### Phase 5: NuGet Validation and Publishing 14. Validate the NuGet packages with by pushing the NuGet packages to a local Packages Source folder, updating the NuGet packages from that folder, and then build the project. 15. Run the PowerShell script `build\promotenuget.ps1 -Version -Release` to promote the version to the Release view on the project-scoped ADO feed. The `-Version` parameter is required and should match the NuGet package version (e.g., `2026.6.2.1`). 16. Run the MSCodeHub pipeline to publish the NuGet packages to nuget.org. The pipeline will automatically push the most recent package promoted to the Release view to nuget.org. ### Phase 6: VCPKG Port Update 17. Git pull a local repository of VCPKG to `d:\vcpkg` in sync with the `main` branch of the VCPKG repository. 18. Run the PowerShell script `build�pdatevcpkg.ps1` to update the DirectXMesh port in VCPKG with the new release version. This will edit the files in `ports\directxmesh`. If the port includes patches, review them to determine if they should be removed or updated for the new release (the `updatevcpkg.ps1` script will warn about this). 19. Test the VCPKG port using the script at `assets/vcpkgdxmesh.cmd` (in this skill folder). Copy it to `d:\vcpkg` and run from there after bootstrapping VCPKG. 20. Run `.\vcpkg x-add-version directxmesh` to update the VCPKG versioning history. 21. Submit a PR to the VCPKG repository to update the DirectXMesh port back to the main GitHub repo. The PR will be reviewed and merged by the VCPKG maintainers. ### Phase 7: WinGet Manifests (Conditional) If relevant changes were made to the `meshconvert` tool: 22. Git pull a local repository to `D:\winget-pkgs` in sync with the `master` branch of the WinGet repository. 23. Run the PowerShell script `build�pdatewinget.ps1` to update the winget manifests for the tool with the new release version. 24. Submit a PR to the `winget` repository to update the manifests for the tool. ### Phase 8: Finalize When fully completed, be sure to update the GitHub release with links to the matching NuGet packages, the VCPKG port, and the winget manifests for the tools. ## Key Scripts | Script | Purpose | | --- | --- | | `build\preparerelease.ps1` | Creates topic branch, updates version numbers and changelog stub | | `build\completerelease.ps1` | Sets tags, creates GitHub release from changelog | | `build\downloadbuild.ps1` | Downloads signed binaries from Azure DevOps | | `build\promotenuget.ps1` | Promotes NuGet package to Release view on ADO feed | | `build�pdatevcpkg.ps1` | Updates DirectXMesh VCPKG port files | | `assets\vcpkgdxmesh.cmd` | Tests VCPKG port across all triplets and features | | `build�pdatewinget.ps1` | Updates winget manifests for CLI tools | ``` ## File: README.md upstream: https://github.com/microsoft/directxmesh/blob/main/README.md ````text ![DirectX Logo](https://raw.githubusercontent.com/wiki/Microsoft/DirectXMesh/X_jpg.jpg) # DirectXMesh geometry processing library https://go.microsoft.com/fwlink/?LinkID=324981 Copyright (c) Microsoft Corporation. ## May 7, 2026 This package contains DirectXMesh, a shared source library for performing various geometry content processing operations including generating normals and tangent frames, triangle adjacency computations, vertex cache optimization, and meshlet generation. This code is designed to build with Visual Studio 2022, Visual Studio 2026, or clang for Windows v12 or later, or MinGW. Use of the Windows 11 SDK ([22000](https://walbourn.github.io/windows-sdk-for-windows-11/)) or later is required for Visual Studio. It can also be built for Windows Subsystem for Linux using GCC 12 or later. These components are designed to work without requiring any content from the legacy DirectX SDK. For details, see [Where is the DirectX SDK?](https://aka.ms/dxsdk). ## Directory Layout * ``DirectXMesh\`` * This contains the DirectXMesh library. > The majority of the header files here are intended for implementation the library only (``DirectXMeshP.h``, ``scoped.h``, etc.). Only ``DirectXMesh.h`` and ``DirectXMesh.inl`` are meant as a 'public' headers for the library. * ``Utilities\`` * This contains helper code related to mesh processing that is not general enough to be part of the DirectXMesh library. * ``WaveFrontReader.h``: Contains a simple C++ class for reading mesh data from a WaveFront OBJ file. * ``FlexibleVertexFormat.h``: Contains helpers for working with Direct3D 9 style "FVF" codes. * ``Meshconvert\`` * This DirectXMesh sample is an implementation of the ``meshconvert`` command-line texture utility from the legacy DirectX SDK utilizing DirectXMesh rather than D3DX. > This tool does not support legacy ``.X`` files, but can export ``CMO``, ``SDKMESH``, and ``VBO`` files. * ``build\`` * Contains miscellaneous build files and scripts. * ``skills\`` * Contains published CoPilot skills for use by developers. ## Documentation Documentation is available on the [GitHub wiki](https://github.com/Microsoft/DirectXMesh/wiki). ## CoPilot Usage For CoPilot CLI assistance with using DirectXMesh, try: ```bash winget install GitHub.Copilot winget install GitHub.cli gh skill install microsoft/directxmesh copilot /skills list ``` ## Notices All content and source code for this package are subject to the terms of the [MIT License](https://github.com/microsoft/DirectXMesh/blob/main/LICENSE). For the latest version of DirectXMesh, bug reports, etc. please visit the project site on [GitHub](https://github.com/microsoft/DirectXMesh). ## Release Notes FOR SECURITY ADVISORIES, see [GitHub](https://github.com/microsoft/DirectXMesh/security/advisories). For a full change history, see [CHANGELOG.md](https://github.com/microsoft/DirectXMesh/blob/main/CHANGELOG.md). * clang-format use for this project must match the version use by GitHub Super-Linter to pass the validation. VS 2022 and VS 2026 come with different versions, so to match use: ```cmd winget install --id=LLVM.LLVM --version 21.1.2 powershell -File build/Format.ps1 -LLVM ``` * The *directxmesh_desktop_win10* and *directxmesh_uwp* NuGet packages are deprecated. The best way to integrate the latest DirectXMesh into your C++ project is using [vcpkg](https://github.com/microsoft/vcpkg/tree/master/ports/directxmesh). * The CMake projects require 3.21 or later. * Starting with the May 2026 release, the functions `OptimizeFaces`, `OptimizeFacesLRU`, `OptimizeFacesEx`, and `OptimizeFacesLRUEx` now take an `nVerts` parameter in order to validate the input indices. This is a *breaking change*. ```cpp hr = OptimizeFaces(indices, nFaces, adjacency, faceRemap, vertexCache, restart); ``` Must be updated to: ```cpp hr = OptimizeFaces(indices, nFaces, nVerts, adjacency, faceRemap, vertexCache, restart); ``` * Starting with the March 2025 release, Windows 7 and Windows 8.0 support has been retired. * Starting with the June 2020 release, this library makes use of typed enum bitmask flags per the recommendation of the *C++ Standard* section *17.5.2.1.3 Bitmask types*. This is consistent with Direct3D 12's use of the ``DEFINE_ENUM_FLAG_OPERATORS`` macro. This may have *breaking change* impacts to client code: * You cannot pass the ``0`` literal as your flags value. Instead you must make use of the appropriate default enum value: ``CNORM_DEFAULT``, ``VALIDATE_DEFAULT``, or ``MESHLET_DEFAULT``. * Use the enum type instead of ``DWORD`` if building up flags values locally with bitmask operations. For example, ```CNORM_FLAGS flags = CNORM_DEFAULT; if (...) flags |= CNORM_WIND_CW;``` * The UWP projects and the Win10 classic desktop project include configurations for the ARM64 platform. Building these requires installing the ARM64 toolset. * When using clang/LLVM for the ARM64/AArch64 platform, the Windows 11 SDK ([22000](https://walbourn.github.io/windows-sdk-for-windows-11/)) or later is required. * As of the October 2024 release, the command-line tool also supports GNU-style long options using ``--``. All existing switches continue to function, but some of the `-` options are now deprecated per this table: |Old switch|New switch| |---|---| |-sdkmesh|-ft sdkmesh
--file-type sdkmesh| |-sdkmesh2|-ft sdkmesh2
--file-type sdkmesh2| |-cmo|-ft cmo
--file-type cmo| |-vbo|-ft vbo
--file-type vbo| |-wf|-ft obj
--file-type obj| |-flipu|--flip-u| |-flipv|--flip-v| |-flipz|--flip-z| ## Support For questions, consider using [Stack Overflow](https://stackoverflow.com/questions/tagged/directxtk) with the *directxtk* tag, or the [DirectX Discord Server](https://discord.gg/directx) in the *dx12-developers* or *dx9-dx11-developers* channel. For bug reports and feature requests, please use GitHub [issues](https://github.com/microsoft/DirectXMesh/issues) for this project. ## Contributing This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA. Tests for new features should also be submitted as a PR to the [Test Suite](https://github.com/walbourn/directxmeshtest/wiki) repository. ## Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. ## Trademarks This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies. ## Credits The DirectXMesh library is the work of Chuck Walbourn, with contributions from Dr. Hugues Hoppe, Alex Nankervis, James Stanard, Craig Peeper, and the numerous other Microsoft engineers who developed the D3DX utility library over the years. Thanks to Matt Hurliman for his contribution of the meshlet generation functions. Thanks to Adrian Stone (Game Angst) for the public domain implementation ````