## upgrade.plan_upgrade()


Compute what bringing this dataset to the current version would do.


Usage

``` python
upgrade.plan_upgrade(
    repo,
    *,
    ignore_immutable=False,
)
```


Runs the plan step of every pending [tether.upgrade.migrations.Migration](upgrade.Migration.md#tether.upgrade.Migration), in order. Actions: `rename-pin` / `rename-branch` (native refs in the stores), `rewrite-history` (historical manifests get the new names), `rewrite-index` / `copy-listing` / `rewrite-state` (what 0.1.0b3 recorded under an identity or state that changed), `vcs-commit`. Nothing is written.


## Parameters


`ignore_immutable: bool = ``False`  
Let the history rewrite touch commits jj marks immutable (recorded in the plan; applied by [apply_upgrade](upgrade.apply_upgrade.md#tether.upgrade.apply_upgrade)).