Skip to content

Refresh remaining docs for #126122#126581

Merged
richlander merged 1 commit intomainfrom
rich/issue-126122-doc-cleanup
Apr 6, 2026
Merged

Refresh remaining docs for #126122#126581
richlander merged 1 commit intomainfrom
rich/issue-126122-doc-cleanup

Conversation

@richlander
Copy link
Copy Markdown
Member

@richlander richlander commented Apr 6, 2026

Note

This PR was AI/Copilot-generated.

Summary

Update the remaining documentation cleanup from #126122, excluding the Tizen and stress-test cases for now.

  • replace the stale WebAssembly image update walkthrough with current Azure Linux / dotnet/versions guidance
  • update the FreeBSD cross-build example to the current prereqs image
  • intentionally leave the Tizen and stress-test references unchanged for follow-up work

Testing

Documentation only.

Ref #126122

@richlander
Update remaining Ubuntu remediation docs
ccb6722 
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings April 6, 2026 17:13
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

dotnet-policy-service bot commented Apr 6, 2026

Tagging subscribers to this area: @dotnet/runtime-infrastructure
See info in area-owners.md if you want to be subscribed.

Copilot AI reviewed Apr 6, 2026
View reviewed changes
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 remaining documentation examples from #126122 to remove stale Ubuntu 18.04-era WebAssembly/FreeBSD cross-build guidance and replace it with current prereqs image / dotnet/versions references.

Changes:

  • Refresh WebAssembly “update Emscripten” walkthrough to reference Azure Linux-based prereqs images and dotnet/versions image-info.
  • Update CoreCLR FreeBSD cross-build Docker example to a newer prereqs image tag.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
docs/workflow/building/libraries/webassembly-instructions.md Rewrites the Emscripten/WebAssembly Docker image update instructions to use Azure Linux + dotnet/versions guidance.
docs/workflow/building/coreclr/cross-building.md Updates the FreeBSD cross-build Docker image tag used in the example command.

@richlander
Copy link
Copy Markdown
Member Author

richlander commented Apr 6, 2026 •
edited
Loading

PTAL @akoeplinger -- feel free to make any changes including applying the Copilot suggestions.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 6, 2026

🤖 Copilot Code Review — PR #126581

Note

This review was AI/Copilot-generated.

Holistic Assessment

Motivation: Justified. The old documentation references Ubuntu 18.04-based Docker images (ubuntu-18.04-cross-freebsd-12, ubuntu-18.04-webassembly) that are long obsolete — Ubuntu 18.04 reached EOL in 2023. The linked issue #126122 tracks a systematic remediation of stale Ubuntu references. This PR addresses the documentation subset of that issue.

Approach: Correct. The FreeBSD cross-build image is updated to match the tag used in the actual CI pipeline (pipeline-with-resources.yml:122). The WebAssembly section is rewritten to remove hardcoded stale examples and instead point to the canonical sources (dotnet-buildtools-prereqs-docker repo, dotnet/versions image-info). This is more maintainable than embedding specific image tags that go stale again.

Summary: ✅ LGTM. This is a straightforward documentation cleanup. The image tags match what CI actually uses, the old content was clearly obsolete, and the new content is accurate and concise. Two minor suggestions below, neither blocking.

Detailed Findings

✅ FreeBSD Image Tag — Matches CI Pipeline

The new tag azurelinux-3.0-net11.0-cross-freebsd-14-amd64 matches exactly what eng/pipelines/common/templates/pipeline-with-resources.yml:122 uses. The automated Copilot reviewer suggested dropping the -amd64 suffix to match docs/workflow/using-docker.md:44, but that table is actually the one that's slightly inconsistent — the pipeline is the source of truth and the PR correctly follows it.

✅ WebAssembly Section — Improved Maintainability

Replacing ~30 lines of hardcoded stale examples (Ubuntu 18.04 tags, old master branch links, obsolete platform-matrix.yml reference) with a concise pointer to the canonical sources is a good approach. The section now won't go stale as quickly.

💡 WebAssembly Image Update Steps — Could Be More Complete (follow-up)

The section instructs readers to update helix-platforms.yml and helix-queues-setup.yml after an Emscripten bump. However, the build/test WebAssembly image in eng/pipelines/common/templates/pipeline-with-resources.yml:112,117 (azurelinux-3.0-net11.0-webassembly-amd64) may also need updating depending on the scope of the change. Consider mentioning this file as well, or noting that the helix images and the build images are separate concerns. This is a minor completeness improvement — not blocking since the section already directs readers to the right repo and manifest.

💡 using-docker.md Tag Discrepancy — Pre-existing (follow-up)

docs/workflow/using-docker.md:44 lists the FreeBSD image as azurelinux-3.0-net11.0-cross-freebsd-14 (no -amd64 suffix), while the pipeline and this PR both use the -amd64 variant. This is a pre-existing inconsistency not introduced by this PR. Worth fixing in a follow-up to avoid confusion, since cross-building.md directs readers to the table in using-docker.md for image names.

Generated by Code Review for issue #126581 · ◷

@richlander
Copy link
Copy Markdown
Member Author

richlander commented Apr 6, 2026

/ba-g "Documentation change"

@richlander richlander merged commit a91e2d0 into main Apr 6, 2026
29 checks passed
@richlander richlander deleted the rich/issue-126122-doc-cleanup branch April 6, 2026 17:21
@dotnet-maestro dotnet-maestro bot mentioned this pull request Apr 8, 2026
Merged
radekdoulik pushed a commit to radekdoulik/runtime that referenced this pull request Apr 9, 2026
@richlander @radekdoulik
Refresh remaining docs for dotnet#126122 (dotnet#126581)
b539334 
> [!NOTE]
> This PR was AI/Copilot-generated.

## Summary
Update the remaining documentation cleanup from dotnet#126122, excluding the
Tizen and stress-test cases for now.

- replace the stale WebAssembly image update walkthrough with current
Azure Linux / `dotnet/versions` guidance
- update the FreeBSD cross-build example to the current prereqs image
- intentionally leave the Tizen and stress-test references unchanged for
follow-up work

## Testing
Documentation only.

Ref dotnet#126122

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@akoeplinger akoeplinger akoeplinger approved these changes

Assignees

@richlander richlander

Labels

area-Infrastructure

Projects

Runtime Infra
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@richlander @akoeplinger