Skip to content

Update developer guide with more details about build analysis checks and workflows#53977

Merged
lbussell merged 3 commits intodotnet:mainfrom
lbussell:buildanalysis-docs
Apr 22, 2026
Merged

Update developer guide with more details about build analysis checks and workflows#53977
lbussell merged 3 commits intodotnet:mainfrom
lbussell:buildanalysis-docs

Conversation

@lbussell
Copy link
Copy Markdown
Member

This PR:

  • Adds a build analysis section to developer-guide.md, with examples for bypassing build analysis.
  • Adds links to GitHUb workflow and source code for each PR maintenance command.
  • Adds a comment linking to documentation in all of the aforementioned workflows.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the developer guide’s “Automated PR Maintenance Commands” documentation to include direct links to the relevant GitHub Actions workflows/source files, and adds “keep the guide in sync” header comments to the referenced workflows.

Changes:

  • Add workflow + source links for /xlf (/updatexlf) and /completions (/fixcompletions) maintenance commands.
  • Document /backport to <branch> and add a new /ba-g <reason> “Bypass Build Analysis” section with example reasons and triage links.
  • Add header comments to the referenced workflows pointing back to documentation/project-docs/developer-guide.md.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File Description
documentation/project-docs/developer-guide.md Expands PR maintenance command docs with workflow/source links and adds backport + build-analysis bypass sections.
.github/workflows/update-xlf-on-comment.yml Adds a header comment linking maintainers back to the developer guide.
.github/workflows/fix-completions-on-comment.yml Adds a header comment linking maintainers back to the developer guide.
.github/workflows/backport.yml Adds a header comment linking maintainers back to the developer guide (and minor whitespace-only diff in template block).

Comment thread .github/workflows/fix-completions-on-comment.yml Outdated
Comment thread .github/workflows/backport.yml Outdated
Comment thread documentation/project-docs/developer-guide.md Outdated
Comment thread documentation/project-docs/developer-guide.md Outdated
Comment thread documentation/project-docs/developer-guide.md
Comment thread .github/workflows/update-xlf-on-comment.yml Outdated
Comment thread .github/workflows/backport.yml
- Remove role/permission language from workflow comments
- Add Action URL links to workflow headers (MiYanni's suggestion)
- List all accepted command aliases in workflow comments
  (/xlf + /updatexlf, /completions + /fixcompletions, /backport to <branch>)
- Update developer-guide.md body text to mention both command aliases

Co-authored-by: Copilot <[email protected]>
@lbussell lbussell force-pushed the buildanalysis-docs branch from 7b0441e to 61da93a Compare April 17, 2026 22:19
@lbussell
Copy link
Copy Markdown
Member Author

/ba-g docs-only change

@lbussell lbussell enabled auto-merge (squash) April 22, 2026 15:00
@lbussell
Copy link
Copy Markdown
Member Author

/ba-g docs-only change

@lbussell lbussell merged commit 7cef932 into dotnet:main Apr 22, 2026
21 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants