Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make process for keeping living release notes in the git repo #6697

Closed
7 tasks done
damyanp opened this issue Jun 14, 2024 · 0 comments · Fixed by #6802
Closed
7 tasks done

Make process for keeping living release notes in the git repo #6697

damyanp opened this issue Jun 14, 2024 · 0 comments · Fixed by #6802
Assignees
@pow2clk
Milestone
Summer 2024 Release

Comments

@damyanp
Copy link
Member

damyanp commented Jun 14, 2024 •
edited by pow2clk
Loading

Rather than gather release notes at release build time, we'd like to accumulate release notes as the changes that necessitate them are added. To do this, we need to have the release notes document available in DXC and establish the process of updating it as we go.

AC:

  • Move release notes README into github (Enable Living Release Notes #6772)
  • Change internal scripts to use the github release notes document
  • Verify nuget and other release packages use these notes
  • update instructions for how to do a release
  • add instructions for how to document a change that requires a release note
  • Add initial set of release notes to match what's in the July release (@python3kgae is doing this in [Release Note] Add release note for 1.8.2407 #6776)
  • After fork, add "upcoming release" section to main for notes for the next release (@pow2clk will do this once the above is done)
@damyanp damyanp added the needs-triage Awaiting triage label Jun 17, 2024
@damyanp damyanp added this to the Mid 2024 Release milestone Jun 17, 2024
@damyanp damyanp removed the needs-triage Awaiting triage label Jun 17, 2024
@damyanp damyanp moved this to Triaged in HLSL Triage Jun 18, 2024
pow2clk added a commit to pow2clk/DirectXShaderCompiler that referenced this issue Jul 11, 2024
@pow2clk
Add living release versions doc
4b7a3b3 
Moving the source file for the README.md for github and nuget releases
into the DXC repo. It should be updated with relevant notes for the
upcoming release whenever they are made in main such that they will
already be available when the release is built.

Fixes microsoft#6697
@pow2clk pow2clk mentioned this issue Jul 11, 2024
Merged
pow2clk added a commit that referenced this issue Jul 11, 2024
@pow2clk
Enable Living Release Notes (#6772)
8fce06b 
Moving the source file for the README.md for github and nuget releases
into the DXC repo. It should be updated with relevant notes for the
upcoming release whenever they are made in main such that they will
already be available when the release is built.

Part of #6697
pow2clk added a commit to pow2clk/DirectXShaderCompiler that referenced this issue Jul 12, 2024
@pow2clk
Add Release Notes guidance to CONTRIBUTING
43874a5 
Add guidance for how release notes should be documented at the time
of the change going in as well as some suggestions for how to format
that documentation.

Contributes to microsoft#6697
@pow2clk pow2clk mentioned this issue Jul 12, 2024
Merged
@pow2clk pow2clk moved this from New to In review in HLSL Roadmap Jul 15, 2024
pow2clk added a commit that referenced this issue Jul 16, 2024
@pow2clk @llvm-beanz
Add Release Notes Guidance to CONTRIBUTING (#6778)
9f0764b 
Add guidance for how release notes should be documented at the time
of the change going in as well as some suggestions for how to format
that documentation.

Contributes to #6697

---------

Co-authored-by: Chris B <cbieneman@microsoft.com>
pow2clk added a commit to pow2clk/DirectXShaderCompiler that referenced this issue Jul 16, 2024
@pow2clk
Enable Living Release Notes (microsoft#6772)
9f7d981 
Moving the source file for the README.md for github and nuget releases
into the DXC repo. It should be updated with relevant notes for the
upcoming release whenever they are made in main such that they will
already be available when the release is built.

Part of microsoft#6697

(cherry picked from commit 8fce06b)
@pow2clk pow2clk mentioned this issue Jul 16, 2024
Merged
pow2clk added a commit that referenced this issue Jul 16, 2024
@pow2clk
Enable Living Release Notes (#6772) (#6792)
f2999a6 
Moving the source file for the README.md for github and nuget releases
into the DXC repo. It should be updated with relevant notes for the
upcoming release whenever they are made in main such that they will
already be available when the release is built.

Part of #6697

(cherry picked from commit 8fce06b)
pow2clk added a commit to pow2clk/DirectXShaderCompiler that referenced this issue Jul 18, 2024
@pow2clk
Add upcoming release section to release notes
6427681 
This is the section where the next release notes will be inserted.
It's just a placeholder instruction for now.

Fixes microsoft#6697
@pow2clk pow2clk mentioned this issue Jul 18, 2024
Merged
@github-project-automation github-project-automation bot moved this from In review to Done in HLSL Roadmap Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pow2clk pow2clk

Labels
None yet
Projects
HLSL Roadmap
Status: Done
HLSL Triage
Archived in project
Milestone
Summer 2024 Release
Development

Successfully merging a pull request may close this issue.

Add upcoming release section to release notes pow2clk/DirectXShaderCompiler
2 participants
@damyanp @pow2clk