Document the snap checklist - #16414
Open
Jakub Jareš (nohwnd) wants to merge 1 commit into
Open
Conversation
The snap has broken publishing from main twice in a row, both times because the new VS <version> Maestro channel was not in the Arcade publishing configuration. It also leaves the new rel/<version> branch without a default channel, which publishes nothing while the build reports success. Neither step was written down anywhere. Add docs/snap.md with the steps and both failure modes, and point at it from AGENTS.md and the Copilot instructions. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a written “snap” checklist to prevent recurring publishing outages after bumping main to a new VS version, and makes that guidance discoverable from agent-facing docs.
Changes:
- Add
docs/snap.mdwith a step-by-step snap checklist (branding PRs, Maestro channel/default-channel actions, Arcade publishing configuration, and how to readPublish Using Darcfailures). - Add short pointers to the checklist in
AGENTS.mdand.github/copilot-instructions.mdto reduce mis-triage of post-snap publishing failures.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/snap.md | New snap checklist documenting the recurring failure modes and the required Maestro/Arcade steps to avoid “Publish Using Darc” outages and silent non-publishing. |
| AGENTS.md | Adds a brief “Snap” section pointing to docs/snap.md and summarizing the two common post-snap publishing pitfalls. |
| .github/copilot-instructions.md | Adds the same “Snap” pointer/symptoms so Copilot guidance doesn’t misclassify the known publishing failure as a repo regression. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The snap has broken publishing from
maintwice in a row, four weeks apart, and both times for the same reason: the newVS <version>Maestro channel was not in the Arcade publishing configuration, so every official build ofmainfailed atPublish Using Darcuntil dnceng added it. That took about two days each time. The same snap also leaves the newrel/<version>branch without a default channel, and those builds report success while publishing nothing. None of it was written down anywhere in the repo.docs/snap.mdis the checklist: the two branding pull requests, creating the channel and pointingmainat it, getting the channel into Arcade'sPublishingConstants.cs, adding the default channel for the new release branch, how to check that a build actually published, and where the real error hides whenPublish Using Darcfails. Both failure modes are written out with their error text and the real channel ids (10800 and 10894) so the next person recognises them.AGENTS.mdand.github/copilot-instructions.mdget a short pointer, so a redPublish Using Darcafter aBranding as <version>commit is not mistaken for a regression.Documentation only. Nothing under
eng/and no build or source file is touched.🤖