Skip to content

docs(site): add PublishPipelineArtifact@1, DownloadPipelineArtifact@2, DeleteFiles@1 to typed-helpers table #1079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+5 −2
Draft

docs(site): add PublishPipelineArtifact@1, DownloadPipelineArtifact@2, DeleteFiles@1 to typed-helpers table #1079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion site/src/content/docs/guides/extending.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ let copy = Step::Task(
);
```

The full set of typed helpers lives in `src/compile/ir/tasks.rs` and is documented in the [IR reference](/ado-aw/reference/ir/#typed-task-helpers). Helpers cover: `CopyFiles@2`, `DockerInstaller@0`, `DotNetCoreCLI@2`, `ArchiveFiles@2`, `ExtractFiles@1`, `PublishTestResults@2`, `NuGetCommand@2`, and `PowerShell@2` (file and inline modes).
The full set of typed helpers lives in `src/compile/ir/tasks.rs` and is documented in the [IR reference](/ado-aw/reference/ir/#typed-task-helpers). Helpers cover: `CopyFiles@2`, `DockerInstaller@0`, `DotNetCoreCLI@2`, `ArchiveFiles@2`, `ExtractFiles@1`, `PublishTestResults@2`, `NuGetCommand@2`, `PowerShell@2` (file and inline modes), `PublishPipelineArtifact@1`, `DownloadPipelineArtifact@2`, and `DeleteFiles@1`.

When no typed helper exists for your task, fall back to `TaskStep::new`:

Expand Down
5 changes: 4 additions & 1 deletion site/src/content/docs/reference/ir.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Those wrappers are the only place per-target shape (top-level `PipelineShape`, t

- `ids.rs` — typed `StageId`, `JobId`, and `StepId` newtypes. Constructors validate the ADO identifier grammar (`^[A-Za-z_][A-Za-z0-9_]*$`) so invalid names fail at compile time.
- `step.rs` — `Step` and concrete step structs: `BashStep`, `TaskStep`, `CheckoutStep`, `DownloadStep`, and `PublishStep`.
- `tasks.rs` — typed factory helpers for built-in ADO task steps (`CopyFiles@2`, `DockerInstaller@0`, `DotNetCoreCLI@2`, `ArchiveFiles@2`, `ExtractFiles@1`, `PublishTestResults@2`, `NuGetCommand@2`, `PowerShell@2`). Prefer these over hand-crafted `TaskStep::new()` calls — see [Typed task helpers](#typed-task-helpers) below.
- `tasks.rs` — typed factory helpers for built-in ADO task steps (`CopyFiles@2`, `DockerInstaller@0`, `DotNetCoreCLI@2`, `ArchiveFiles@2`, `ExtractFiles@1`, `PublishTestResults@2`, `NuGetCommand@2`, `PowerShell@2`, `PublishPipelineArtifact@1`, `DownloadPipelineArtifact@2`, `DeleteFiles@1`). Prefer these over hand-crafted `TaskStep::new()` calls — see [Typed task helpers](#typed-task-helpers) below.
- `job.rs` — `Job`, `Pool`, job variables, 1ES `templateContext` support, and target-job external `dependsOn` / `condition` wrapping.
- `stage.rs` — `Stage` plus target-stage external `dependsOn` / `condition` wrapping.
- `env.rs` — typed environment values (`EnvValue`) including ADO macros, pipeline variables, secrets, `OutputRef`s, `Coalesce`, and macro-form `Concat`.
Expand Down Expand Up @@ -134,6 +134,9 @@ These helpers eliminate hand-crafted `TaskStep::new(…)` + raw string inputs at
| `nuget_command_step(command)` | `NuGetCommand@2` | operation (`"restore"`, `"push"`, `"pack"`, `"custom"`) |
| `powershell_file_step(file_path)` | `PowerShell@2` (file mode) | path to `.ps1` script |
| `powershell_inline_step(script)` | `PowerShell@2` (inline mode) | inline script body |
| `publish_pipeline_artifact_step(target_path)` | `PublishPipelineArtifact@1` | path to the file or directory to publish (ADO macros OK; wildcards not supported) |
| `download_pipeline_artifact_step(target_path)` | `DownloadPipelineArtifact@2` | local destination path for the downloaded artifact |
| `delete_files_step(contents)` | `DeleteFiles@1` | newline-separated glob patterns identifying files/folders to remove |

### Usage example

Expand Down