Skip to content

docs(site): fix codemods file layout and add registered codemods table #694

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

Merged
jamesadevine merged 1 commit into from
May 22, 2026
+13 −5
Merged

docs(site): fix codemods file layout and add registered codemods table #694

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
18 changes: 13 additions & 5 deletions site/src/content/docs/reference/codemods.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ rewrite deprecated front-matter shapes to the current shape during
This page is the reference for both users (what codemods mean for me)
and contributors (how to add one).

## Registered codemods

| ID | Summary | Introduced in |
|----|---------|---------------|
| `repos_unified` | `repositories:` + `checkout:` → unified `repos:` | 0.28.0 |
| `pool_object_form` | `pool: <string>` → explicit `pool:` object form (`name` / `vmImage`) | 0.30.0 |

If `ado-aw compile` rewrites your source, it prints a warning to stderr naming each codemod that fired and reminding you that front-matter comments are dropped by the round-trip.

## How it works

### No version field on user files
Expand Down Expand Up @@ -107,11 +116,10 @@ Codemods live in `src/compile/codemods/`:

```text
src/compile/codemods/
├── mod.rs # Framework + CODEMODS registry
├── helpers.rs # take_key, insert_no_overwrite, rename_key, ConflictPolicy
├── 0001_engine_id_split.rs
├── 0002_permissions_field.rs
└── 0003_safeoutput_renames.rs
├── mod.rs # Framework + CODEMODS registry
├── helpers.rs # take_key, insert_no_overwrite, rename_key, ConflictPolicy
├── 0001_repos_unified.rs # repositories: + checkout: -> unified repos:
└── 0002_pool_object_form.rs # pool: <string> -> pool object form (name/vmImage)
```

The filename prefix is a zero-padded sequence number (`<NNNN>`). It
Expand Down