Canary release notes should go to the commit on Github #21333

Open
opened 2026-01-31 07:41:27 +00:00 by claunia · 4 comments
Owner

Originally created by @pcause on GitHub (Mar 1, 2024).

In help/about I click release notes. I don't get the canary release notes. I should either get them or there should be somewhere I can get the release notes. I look in git and can't find a branch for the commits for a canary version

Originally created by @pcause on GitHub (Mar 1, 2024). <!-- Briefly describe which document needs to be corrected and why. --> In help/about I click release notes. I don't get the canary release notes. I should either get them or there should be somewhere I can get the release notes. I look in git and can't find a branch for the commits for a canary version
claunia added the Issue-TaskProduct-TerminalArea-UserInterface labels 2026-01-31 07:41:27 +00:00
Author
Owner

@zadjii-msft commented on GitHub (Mar 1, 2024):

Honestly, not a bad idea to have the canary link just go to: 6e451a2d4b (or similar).

I'm not sure we have an affordance for stamping the current git commit hash into the code anywhere quite yet.

Similarly: #2783

@zadjii-msft commented on GitHub (Mar 1, 2024): Honestly, not a bad idea to have the canary link just go to: https://github.com/microsoft/terminal/commits/6e451a2d4b6574aed846385b8223894472366805 (or similar). I'm not sure we have an affordance for stamping the current git commit hash into the code anywhere quite yet. Similarly: #2783
Author
Owner

@zadjii-msft commented on GitHub (Mar 1, 2024):

We'd need something like https://github.com/microsoft/terminal/blob/main/build/rules/GenerateFeatureFlags.proj, but separate from velocity. It'd need to generate a separate header for including (since the feature flags header is included everywhere and I wouldn't want that polluting the entire tree every time you commit.

or even wilder, I wonder if we could stick it in the package resources, and just have the dialog look it up that way. Then, the only thing that would be dirtied on a commit is the package itself (which like, yea, is probably dirty from code changes anyways).

This
ec5d246b35/src/cascadia/CascadiaPackage/CascadiaPackage.wapproj (L53-L60)

makes me think that's possible, but idk if ScopedResourceLoader can get the resources from the package like that. (or if it works in the case of an unpackaged canary build)

Actually unpackaged pretty much kills that idea entirely, doesn't it. Uhg.

@zadjii-msft commented on GitHub (Mar 1, 2024): We'd need something like https://github.com/microsoft/terminal/blob/main/build/rules/GenerateFeatureFlags.proj, but separate from velocity. It'd need to generate a separate header for including (since the feature flags header is included _everywhere_ and I wouldn't want that polluting the entire tree every time you commit. or even wilder, I wonder if we could stick it in the package resources, and just have the dialog look it up that way. Then, the only thing that would be dirtied on a commit is the package itself (which like, yea, is probably dirty from code changes anyways). This https://github.com/microsoft/terminal/blob/ec5d246b35fbb0feb1bc2cbbff1b4b11362a2824/src/cascadia/CascadiaPackage/CascadiaPackage.wapproj#L53-L60 makes me think that's possible, but idk if ScopedResourceLoader can get the resources from the package like that. (or if it works in the case of an unpackaged canary build) Actually unpackaged pretty much kills that idea entirely, doesn't it. Uhg.
Author
Owner

@pcause commented on GitHub (Mar 1, 2024):

thanks. not sure what to try/test/give feedback on without this.

@pcause commented on GitHub (Mar 1, 2024): thanks. not sure what to try/test/give feedback on without this.
Author
Owner

@zadjii-msft commented on GitHub (Mar 1, 2024):

Okay other thoughts, cribbed from Teams

Msbuild additional args, /p:AgentBuildCommit=$(Build.Commit) and then AgentBuildCommit into a -D for ClCompile
Then just refer to it in the code directly

well yea but that's the same as "every commit dirties the header"

unless we only did it for can builds

Now that's an idea. Only #define it at all in Can branded releases, so that otherwise, the defines don't change on a commit. This would only work for stamping the commit on a Canary (or preview or release) branded build, but I think that's reasonable. Dirtying a file on every local dev build seems egregious.

@zadjii-msft commented on GitHub (Mar 1, 2024): Okay other thoughts, cribbed from Teams > Msbuild additional args, /p:AgentBuildCommit=$(Build.Commit) and then AgentBuildCommit into a -D for ClCompile > Then just refer to it in the code directly > well yea but that's the same as "every commit dirties the header" > unless we only did it for can builds Now that's an idea. Only #define it at all in Can branded releases, so that otherwise, the defines don't change on a commit. This would only work for stamping the commit on a Canary (or preview or release) branded build, but I think that's reasonable. Dirtying a file on every local dev build seems egregious.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/terminal#21333