Set run name to use source branch's commit message #529
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…g for resource variables.
…nment variables for debugging.
…ld.BuildNumber to a separate variable for the build.
…commit message it should be showing. Trying compile-time syntax for the OfficialBuildId.
MiYanni
commented
Sep 10, 2025
Comment on lines
+2
to
+3
| sourceBranchAlias: self | ||
| engBranchAlias: eng |
Member
Author
There was a problem hiding this comment.
I updated these parameter names to be more accurate as it was confusing since they aren't actually the branch names, but aliases to the repository for those branches.
…this branch's PR build.
joeloff
reviewed
Sep 11, 2025
joeloff
approved these changes
Sep 11, 2025
…arameter display name casing to be consistent.
MiYanni
commented
Sep 11, 2025
| parameters: | ||
| - name: sourceBranch | ||
| displayName: 🚩 Source Branch 🚩 | ||
| displayName: 🚩 Source branch 🚩 |
Member
Author
There was a problem hiding this comment.
Adjusted pipeline parameter display names to have consistent casing.
MiYanni
added
the
DO NOT MERGE
joeloff
approved these changes
Sep 12, 2025
Member
Author
|
Arcade PRs merged. Awaiting VMR flow... |
Member
Author
|
Changes from Arcade are merged in for 9. |
Member
Author
|
|
MiYanni
removed
the
DO NOT MERGE
This was referenced Sep 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
When running the official build, the run name will always show the last commit message from the
engbranch, which is not desired. What is ideal is showing the last commit message from the provided 'source branch' when the pipeline is ran. I figured this would be pretty simple and straightforward to set, but it was not. 😭Details
When running a build, Azure Pipelines will, by default, use this format for the run name:
We actually want the
$(Build.SourceVersionMessage)to be from the 'source branch' and not theengbranch. But, this value is not configurable. Updating the run name would be simple if there was just a "display name" value for this. However, there is not. Instead, it works as such:#as the first character no matter the settings.$(Date:yyyyMMdd).$(Rev:r)portion is actually the$(Build.BuildNumber)value.• $(Build.SourceVersionMessage)portion is actually shown via a boolean appendCommitMessageToRunName, which is set totrueby default.The only way to change this run name is by doing the following:
falsefor the pipeline so the default commit message is no longer appended to the run name.$(Build.BuildNumber)via the logging command,build.updatebuildnumber.This allows you to "fully customize" the run name as long as
Build.BuildNumberdoes not:Characters which are not allowed include '"', '/', ':', '<', '>', '\', '|', '?', '@', and '*'.So, I've been forced to clean the commit message from the source branch when I gather it to adhere to these requirements. This normally doesn't require this level of scrutiny when the default
appendCommitMessageToRunNameis used.Another problem arose. Apparently, Arcade uses
$(Build.BuildNumber)in various places. Generally, it is set to theOfficialBuildIdproperty. We send that value here when we build, so I simply save the original value to aOfficialBuildIdvariable, and then use that when we build. That resolved the build issue.The other Arcade issue is that the 'Publish Assets' stage has the use of
$(Build.BuildNumber)hard-coded to be theOfficialBuildIdproperty. To solve that, I've created a PR for Arcade to allow setting theOfficialBuildIdproperty in 'Publish Assets' stage via the jobs.yml parameters. This change is required prior to merging this PR.