Skip to content

Commit f8ef483

Browse files
authored
[NFC][Docs] Update release notes / release template process (microsoft#7100)
Some update to clarify the release procedure and to update the current release notes with PR links. The readme should also now mention the inclusion of dxv.exe in each release.
1 parent c2ed9ad commit f8ef483

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed

.github/ISSUE_TEMPLATE/release.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ assignees: ''
1313
- At this point, changes must be cherry-picked into the release branch in
1414
order for them to be included in the release.
1515
- [ ] MM/DD/YYYY - Release Candidate 1 (begin Ask Mode[^1] for release branch).
16-
- At this point, changes must be approved by @microsoft/hlsl-release
16+
- At this point, cherry-picked changes must be approved by @microsoft/hlsl-release
1717
- [ ] MM/DD/YYYY - Final Release Candidate
1818
- [ ] MM/DD/YYYY - Target Release Date
1919

@@ -26,7 +26,7 @@ This part of the release process is to 'prime the pump' - that is to make sure
2626
that all the various parts of the engineering system are set into place so that
2727
we are confident we can generate builds for the new branch
2828

29-
- [ ] Update version number
29+
- [ ] Update version numbers in utils/version/latest-release.json and utils/version/version.inc
3030
- [ ] Create the release branch from `main`
3131
- The release branch is kept into sync with main via regular fast-forward
3232
merges.
@@ -39,7 +39,7 @@ we are confident we can generate builds for the new branch
3939

4040
## After Fork
4141

42-
- [ ] Update README.md
42+
- [ ] Update README.md if necessary
4343
- [ ] Create draft of Release post on GitHub
4444

4545
## Quality Sign Off

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ At the moment, the DirectX HLSL Compiler provides the following components:
1818

1919
- dxilconv.dll, a DLL providing a converter from DXBC (older shader bytecode format)
2020

21+
- dxv.exe, a command-line tool that validates DXIL IR (compiled HLSL programs).
22+
2123
- various other tools based on the above components
2224

2325
The Microsoft Windows SDK releases include a supported version of the compiler and validator.

docs/ReleaseNotes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ Place release notes for the upcoming release below this line and remove this lin
2323

2424
### Version 1.8.2502
2525

26-
- The incomplete WaveMatrix implementation has been removed.
27-
- DXIL Validator Hash is open sourced.
28-
- DXIL container validation for PSV0 part allows any content ordering inside string and semantic index tables.
29-
- The and() and or() intrinsics will now accept non-integer parameters by casting them to bools.
26+
- The incomplete WaveMatrix implementation has been removed. [#6807](https://github.com/microsoft/DirectXShaderCompiler/pull/6807)
27+
- DXIL Validator Hash is open sourced. [#6846](https://github.com/microsoft/DirectXShaderCompiler/pull/6846)
28+
- DXIL container validation for PSV0 part allows any content ordering inside string and semantic index tables. [#6859](https://github.com/microsoft/DirectXShaderCompiler/pull/6859)
29+
- The and() and or() intrinsics will now accept non-integer parameters by casting them to bools. [#7060](https://github.com/microsoft/DirectXShaderCompiler/pull/7060)
3030

3131
### Version 1.8.2407
3232

0 commit comments

Comments
 (0)