docs(site): document typed task helpers in ir.mdx and extending.mdx#1069
Merged
Merged
Conversation
- Add tasks.rs to the Module Layout section in ir.mdx - Add new 'Typed task helpers' section to ir.mdx documenting all 9 factory functions (CopyFiles@2, DockerInstaller@0, DotNetCoreCLI@2, ArchiveFiles@2, ExtractFiles@1, PublishTestResults@2, NuGetCommand@2, PowerShell@2 file+inline modes), including required-param table, usage examples, and contributor guidance for adding new helpers - Update 'Task steps' section in extending.mdx to surface the typed helpers as the preferred pattern over raw TaskStep::new() calls, with cross-link to the ir.mdx reference Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Open
jamesadevine
approved these changes
Jun 17, 2026
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
1 participant
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
tasks.rs— several added in recent PRs (feat(ir): add typed helper for DotNetCoreCLI@2 #1025, feat(ir): add typed helper for ArchiveFiles@2 #1028, feat(ir): add typed helper for ExtractFiles@1 #1042, feat(ir): add typed helper for NuGetCommand@2 #1047, feat(ir): add typed helpers for PowerShell@2 #1051) but absent from the site until now.TaskStep::new" to "prefer typed helpers, fall back to raw API when needed."Changes
site/src/content/docs/reference/ir.mdxtasks.rsto the Module Layout section (with anchor link to the new section)dot_net_core_cli_step,publish_test_results_step,powershell_inline_step)Step::RawYamlis wrong for typed stepssite/src/content/docs/guides/extending.mdxTaskStep::newexample as the explicit fallback for tasks without a typed helperAccuracy checks
src/compile/ir/tasks.rspub fnspub fnCopyFiles@2,DockerInstaller@0, etc.) verified fromTaskStep::new(...)calls intasks.rstasks.rs+step.rsAPI (.with_input()chains are correct)tasks.rsValidation
cd site && npm ci && npm run build— 36 pages built, all internal links validCreated by the docs-writer workflow.