Vulkan-Docs/.gitlab/issue_templates/Release checklist.md
Jon Leech e24e42dcff Change log for November 4, 2018 Vulkan 1.1.91 spec update:
* Update release number to 91.

Public Issues:

  * Update Ubuntu subsystem build instructions in `BUILD.adoc` (public pull
    request 624).
  * Delete the `VK_KHR_mir_surface` extension from the Specification and
    XML, due to EOL of the only driver known to have supported it, and
    near-EOL of Mir itself (public issue 814).
  * Fix options for some figures that were using old ones (public pull
    request 841).
  * Fix various accidentally repeated words (public pull request 843).
  * Use `time.process_time()`, introduced in Python 3.3, in the scripts
    instead of `time.clock()`, which will be removed in Python 3.8 (public
    pull request 844).

Internal Issues:

  * Update valid usage statements for
    `VK_ANDROID_external_memory_android_hardware_buffer` in
    slink:VkMemoryAllocateInfo,
    slink:VkImportAndroidHardwareBufferInfoANDROID, and
    flink:vkGetAndroidHardwareBufferPropertiesANDROID to actually be
    verifiable (internal issue 1419).
  * Update valid usage statements for
    `VK_ANDROID_external_memory_android_hardware_buffer` in
    slink:VkMemoryAllocateInfo, slink:VkImageCreateInfo, and
    slink:VkImageViewCreateInfo to move valid usage statements in
    doubly-nested bullet points up one level, accomodating limitations of
    the valid usage extraction script that creates `validusage.json`
    (internal issue 1434).
  * Fix typo etext:VK_ACCESS_SHADING_RATE_IMAGE_BIT_NV to the correct
    ename:VK_ACCESS_SHADING_RATE_IMAGE_READ_BIT_NV.
  * Add missing etext:VK_STRUCTURE_TYPE_* tokens to appendices for
    extensions missing them.

New Extensions:

  * `VK_AMD_memory_overallocation_behavior`
  * `VK_NV_ray_tracing`, replacing `VK_NVX_raytracing`
2018-11-03 23:50:13 -07:00

3.0 KiB

Vulkan Feature Development Checklist Template

This template captures checklists for the stages of development that a Vulkan KHR extension passes through as it moves from development to ratification and release. You should create an issue from this template when the extension draft is stable and there is reasonable consensus in the working group that it is on a path to ratification.

Edit the template to suit the extension you are considering (and to delete the italicized instructions). Delete any requirements that are not relevant; for example, an extension that has no language dependencies will not need SPIR-V / GLSL / HLSL items, and an EXT GLSL extension will not require Promoter ratification.

Requirements may be waived by vote of the working group, provided that a 2/3 majority of non-abstaining vote are in favor.

Preconditions for Call for Votes (CfV)

A formal CfV is issued following agreement at a Tuesday meeting that a vote should be held at the following Tuesday meeting. Preconditions for a CfV are as follows; "specification stable" means that there are no MRs in flight that modify behavior defined by the extension and its dependencies. Delete any of the following preconditions that are not relevant to the extension in question

  • VAP consulted to the extent the WG considers appropriate
  • CTS tests approved with three passing implementations
  • Vulkan API specification merged and stable in devel
  • SPIR-V specification merged and stable
  • GLSL specification merged and stable

Preconditions for submission to Promoters

  • WG vote to submit passed with a 3/4 majority
  • Submission package available for Promoter review

Preconditions for creating public release issue on GitHub

Delete any of the following preconditions that are not relevant to the extension in question. Enter target dates for software artifacts where indicated. Note that these are targets and may slip.

  • Vulkan specification ratified by Promoters
  • SPIR-V specification ratified by Promoters
  • GLSL specification ratified by Promoters
  • GLSLang implementation release schedule agreed: target target-date
  • Marketing summary written and approved by Vulkan WG and PR team
  • Validation layer implementation approved to merge
  • Loader support approved to merge (for instance extensions)
  • HLSL mapping defined
  • HLSL mapping supported in GLSLang
  • HLSL mapping supported in DXC
  • CTS release schedule agreed: target target-date
  • SDK release schedule agreed: target target-date
  • SPIR-V tools implementation schedule agreed: target target-date
  • Public release schedule agreed: target target-date

Preconditions for closing this issue

  • Public release issue items checked off and issue closed

Additional (Optional) Items

These additional items are recommended for creation at some point during or after the release, but are not required at any point.

  • Usage Examples
  • Usage Advice