Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
  • Loading branch information
ggwpez committed May 13, 2024
1 parent 51a8a37 commit 3c95c77
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,27 @@ zepter
- dependency
- lift-to-workspace: Lifts crate dependencies to the workspace.

## Example - Using Workspace dependencies

Currently this only works for external dependencies and has some cases where it does not work. However, all the changes
that it *does* do, should be correct.

You can see this in action for example [here](https://github.com/paritytech/polkadot-sdk/pull/3366) or try it out yourself.
For example, pulling up all `serde*` crates to the workspace can look like this:

```bash
zepter transpose dependency lift-to-workspace "regex:^serde.*" --ignore-errors
```

It will probably print that some versions are not aligned. Zepter has the default behaviour to be cautious to not accidentally
update some dependencies by pulling them up. To get around this and actually do the changes, you can do:

```bash
zepter transpose dependency lift-to-workspace "regex:^serde.*" --ignore-errors --fix --version-resolver=highest
```

This will try to select the "highest" SemVer version of each crate.

## Example - Feature Formatting

To ensure that your features are in canonical formatting, just run:
Expand Down

0 comments on commit 3c95c77

Please sign in to comment.