Attach retry instructions to release automation build as a markdown doc #51
Conversation
Upload a doc describing how to retry to the AzDO build as a "summary" of the build. This makes AzDO display the subset-of-markdown document its own tab on the build summary screen, which is a lot easier to get to than digging into the logs of a specific build step to find the instructions. This is also an opportunity to filter out unnecessary instructions. Update release docs to match. Include a direct link to the page showing the retry doc in status update release issue comments. Fix an inconsistent "." in the Report Failure step vs. the Report Success step.
azdo/azdo.go
Outdated
| // UploadBuildSummary uses an AzDO logging command to upload a build summary. When used on a | ||
| // markdown file, the rendered document shows up on the build page in an "Extensions" tab. The path | ||
| // must be a full path. | ||
| func UploadBuildSummary(path string) { |
There was a problem hiding this comment.
This is more generic than build, can be used to upload anything. Consider naming UploadSummary
There was a problem hiding this comment.
Hmm, what I originally had in mind for the name was that it's just specifying "AzDO build" for a little clarify at the point where the func is used. Similar to GetBuildWebURL. (But upload a build summary in the comment ruins that.)
For task.setvariable I had the same thing in mind, but I called it SetPipelineVariable(name, value string). Not consistent vs. Build.
Maybe it'd get the point across better to make it explicit and stick more closely to the task.setvariable/task.uploadsummary names: LogCmdSetVariable, LogCmdUploadSummary. It would also make it easier to recognize that this isn't a network call. (The lack of ctx context.Context and return value seems odd if you think it's a network call.) I'm doing this rename.
Rename AzDO logging command funcs to use LogCmd prefix and follow the AzDO command naming more closely. Update comments: improve descriptions and link to the new logging command doc page rather than the old one.
Upload a doc describing how to retry to the AzDO build as a "summary" of the build. This makes AzDO display the subset-of-markdown document its own tab on the build summary screen, which is a lot easier to get to than digging into the logs of a specific build step to find the instructions. This is also an opportunity to filter out unnecessary instructions.
Update release docs to match.
Include a direct link to the page showing the retry doc in status update release issue comments.
Fix an inconsistent "." in the Report Failure step vs. the Report Success step.
The doc looks like this in the build:
And the comment on the release issue looks like this:
Changes to the repo-side instructions doc are here: https://github.com/dagood/go-infra/blob/dev/dagood/retry-doc/docs/release-process/instructions.md#retrying