Skip to content

Update release issue template to handle latest release procedure - #8757

Merged
joaosaffran merged 6 commits into
microsoft:mainfrom
joaosaffran:release/releast-issue-template
Aug 17, 2026
Merged

Update release issue template to handle latest release procedure#8757
joaosaffran merged 6 commits into
microsoft:mainfrom
joaosaffran:release/releast-issue-template

Conversation

@joaosaffran

Copy link
Copy Markdown
Collaborator

This patch updates the Release issue template to also account for the SPIRV SDK release and to account for NVIDIA validating SPIRV instead of google.

Fix: microsoft/hlsl-specs#888

Copilot AI balanced review requested due to automatic review settings August 10, 2026 19:48

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the release issue template to reflect the latest SPIR-V release process.

Changes:

  • Adds final branch synchronization and SPIR-V submodule updates.
  • Replaces Google sign-off with NVIDIA sign-off.
  • Adds LunarG release notification.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.


- [ ] Tag final release and post binaries
- [ ] Add the new compiler to Compiler Explorer
- [ ] Email LunarG the release tag and update the release spreadsheet.

@alsepkow Alex Sepkowski (alsepkow) Aug 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this still apply to all spot releases/releases? I think it will only apply to when we are doing a release alongside LunarG?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it only applies for when we are releasing alongside LunarG. However this issue doesn't seem to distinguish between different releases. For example, it doesn't specify what is part of a spot release or a full release.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's because we weren't consistently creating issues for spot releases before. Maybe now is a good time to add the differentiation? Or maybe it's obvious enough when it doesn't apply

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably have a different issue for each. Or maybe a branch within the issue. I've done a number of point releases using the release issue and its always awkward

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the idea of having a different issue for point releases, but I still think that those will have a bunch of branches within them, depending on where we release and what we are releasing.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already have too many issue templates, I'm not keen on adding another one. I think instructions to "delete as appropriate" or maybe being able to list some as "point release only" or "major release only" would work.

Another tool we have is that we can put HTML comments or other instructions into the template - it's reasonable to expect the person creating the new release to have to edit / customize it a bit. We already expect them to fill in the dates, for example.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added some minor comments pointing Damyan Pepper (@damyanp) suggestions

Copilot AI review requested due to automatic review settings August 12, 2026 00:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

.github/ISSUE_TEMPLATE/release.md:56

  • Use the official NuGet capitalization, consistent with the package name on line 39 and in README.md.
- [ ] Publish the new compiler Nuget package.

Copilot AI review requested due to automatic review settings August 17, 2026 18:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (5)

.github/ISSUE_TEMPLATE/release.md:11

  • Typo: change 'bellow' to 'below' in this comment.
<!-- Some of the steps bellow might not be required, delete them as appropriate -->

.github/ISSUE_TEMPLATE/release.md:25

  • Grammar fixes would make these instructions clearer: use 'doesn't exist' (not 'don't exist') and 'kept in sync' (not 'kept into sync').
<!-- This is only required if the release branch don't exist -->

.github/ISSUE_TEMPLATE/release.md:34

  • Grammar fixes would make these instructions clearer: use 'doesn't exist' (not 'don't exist') and 'kept in sync' (not 'kept into sync').
    - The release branch is kept into sync with main via regular fast-forward

.github/ISSUE_TEMPLATE/release.md:41

  • Brand capitalization: change 'github' to 'GitHub'.
    - [ ] Zip files for github release

.github/ISSUE_TEMPLATE/release.md:60

  • These checklist items mix end punctuation (some end with periods, others don’t). For consistency/readability in templates, standardize punctuation across the list (either all with periods or all without).
- [ ] Email LunarG the release tag and update the release spreadsheet.
- [ ] Publish the new compiler Nuget package.
- [ ] Tag final release and post binaries

Comment thread .github/ISSUE_TEMPLATE/release.md Outdated
Comment thread .github/ISSUE_TEMPLATE/release.md Outdated
Comment on lines 36 to 43
- [ ] Final merge of `main` into the release branch
- [ ] Update SPIRV-Headers and SPIRV-Tools submodules, in the release branch,
to target the commits specified by LunarG.
- [ ] Internal branches and build pipelines configured
- Verify that the engineering system can build:
- [ ] Zip files for github release
- [ ] NuGet package
- [ ] VPack

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Configuring the branches and build pipelines needs to happen before the final merge of main.

Suggested change
- [ ] Final merge of `main` into the release branch
- [ ] Update SPIRV-Headers and SPIRV-Tools submodules, in the release branch,
to target the commits specified by LunarG.
- [ ] Internal branches and build pipelines configured
- Verify that the engineering system can build:
- [ ] Zip files for github release
- [ ] NuGet package
- [ ] VPack
- [ ] Internal branches and build pipelines configured
- Verify that the engineering system can build:
- [ ] Zip files for github release
- [ ] NuGet package
- [ ] VPack
- [ ] Final merge of `main` into the release branch
- [ ] Update SPIRV-Headers and SPIRV-Tools submodules, in the release branch,
to target the commits specified by LunarG.

@github-project-automation github-project-automation Bot moved this from New to In progress in HLSL Roadmap Aug 17, 2026
Co-authored-by: Damyan Pepper <damyanp@microsoft.com>
Copilot AI review requested due to automatic review settings August 17, 2026 18:32

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

.github/ISSUE_TEMPLATE/release.md:11

  • Corrected spelling of 'bellow' to 'below' in the guidance comment.
<!-- Some of the steps bellow might not be required, delete them as appropriate -->

@damyanp

Copy link
Copy Markdown
Member

Also please check copilot github "suppressed comments" under the various copilot review comments - these highlight various spelling and grammatical errors that would be good to fix.

Comment thread .github/ISSUE_TEMPLATE/release.md Outdated
- [ ] Add the new compiler to Compiler Explorer
- [ ] Email LunarG the release tag and update the release spreadsheet.
- [ ] Publish the new compiler Nuget package.
- [ ] Tag final release and post binaries

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is chronological, it seems the tagging should still be first even if posting the binaries to the release should be last.

Comment thread .github/ISSUE_TEMPLATE/release.md Outdated
---


<!-- Some of the steps bellow might not be required, delete them as appropriate -->

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though it's a comment. This is pretty broad. If any step can be skipped I see how creating a new release branch might not be needed for a point release, are there others?

typo

Suggested change
<!-- Some of the steps bellow might not be required, delete them as appropriate -->
<!-- Some of the steps below might not be required, delete them as appropriate -->

Copilot AI review requested due to automatic review settings August 17, 2026 19:06

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (3)

.github/ISSUE_TEMPLATE/release.md:57

  • This change removes the Google testing sign-off entirely and does not preserve the previous indentation (it used to be a sub-item). If Google sign-off is still required, it should be retained (and either kept as a separate top-level checkbox alongside Microsoft/NVIDIA, or restored as a nested item consistently). If it’s intentionally removed, please adjust the surrounding section to avoid losing that requirement silently (e.g., replace with a generic 'Partner testing sign-offs' list).
## Quality Sign Off

- [ ] Microsoft Testing Sign-off (@damyanp)
- [ ] NVIDIA Testing Sign-off (@dnovillo / @pow2clk)

.github/ISSUE_TEMPLATE/release.md:47

  • This step depends on an external source of truth ('commits specified by LunarG') but doesn’t indicate where to find them. Consider adding a pointer (e.g., link to the specific LunarG guidance location, email alias, or a standard document / tag naming convention) so release owners can execute this reliably without institutional knowledge.
- [ ] Update SPIRV-Headers and SPIRV-Tools submodules, in the release branch,
      to target the commits specified by LunarG.

.github/ISSUE_TEMPLATE/release.md:65

  • The official brand casing is typically 'NuGet' rather than 'Nuget'. Consider changing 'Nuget' to 'NuGet' for consistency with earlier references in this template.
- [ ] Email LunarG the release tag and update the release spreadsheet.
- [ ] Publish the new compiler Nuget package.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (3)

.github/ISSUE_TEMPLATE/release.md:57

  • The diff removes the Google testing sign-off item but does not add a replacement for it; instead, it adds NVIDIA. If Google sign-off is still required, re-add it as its own checklist item (and keep indentation consistent with the other sign-offs). If it is intentionally no longer required, consider adding a short comment explaining the change to avoid process confusion.
## Quality Sign Off

- [ ] Microsoft Testing Sign-off (@damyanp)
- [ ] NVIDIA Testing Sign-off (@dnovillo / @pow2clk)

.github/ISSUE_TEMPLATE/release.md:47

  • This task depends on an external source of truth (“commits specified by LunarG”) but doesn’t indicate where to find those commits (email? doc? repo issue?). Add a direct link or a brief pointer (e.g., location in LunarG tracking issue / version file) so release owners can reliably execute the step.
- [ ] Update SPIRV-Headers and SPIRV-Tools submodules, in the release branch,
      to target the commits specified by LunarG.

.github/ISSUE_TEMPLATE/release.md:64

  • This step references a “release spreadsheet” without identifying it. Please include a link to the spreadsheet (or the internal doc location), and ideally the distribution list/contact address for LunarG, to make the template actionable for new release owners.
- [ ] Email LunarG the release tag and update the release spreadsheet.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

.github/ISSUE_TEMPLATE/release.md:57

  • The diff removes the 'Google Testing Sign-off' line but does not add it back elsewhere; instead it adds an NVIDIA sign-off as a peer item. If the intent was to replace Google with NVIDIA, the indentation change should be deliberate and consistent; otherwise, re-add Google testing sign-off (or keep both) and ensure the list nesting/structure matches the intended workflow.
## Quality Sign Off

- [ ] Microsoft Testing Sign-off (@damyanp)
- [ ] NVIDIA Testing Sign-off (@dnovillo / @pow2clk)

@joaosaffran
joaosaffran merged commit c1104ee into microsoft:main Aug 17, 2026
13 checks passed
@github-project-automation github-project-automation Bot moved this from In progress to Done in HLSL Roadmap Aug 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Update DXC Release issue template to contain the vk sdk release steps

8 participants