Skip to content

Commit

Permalink
docs: Added poetry like behavior to readme
Browse files Browse the repository at this point in the history
New commands are updated in documentation
  • Loading branch information
carstencodes committed Aug 1, 2023
1 parent c02d040 commit 336a786
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,25 @@ $ pdm bump minor # creates 0.2.0 from 0.1.2
$ pdm bump major # creates 1.0.0 from 1.0.0
```

### Migrating from `poetry`

If you used to work with `poetry`, the `pdm` `bump` plugin will actually include all the commands
that you are used to work with in the `poetry` `version` [command](https://python-poetry.org/docs/cli/#version).

So you can actually use the following commands in the same way:

| `poetry version` | `pdm bump` | Remarks |
| ---------------- | ---------------- | ---------------------------------------------- |
| `major` | `major` | No 1:1 implementation, but compatible behavior |
| `minor` | `minor` | No 1:1 implementation, but compatible behavior |
| `patch` | `patch`, `micro` | No 1:1 implementation, but compatible behavior |
| `premajor` | `premajor` | Implemented according to poetry documentation |
| `preminor` | `preminor` | Implemented according to poetry documentation |
| `prepatch` | `prepatch` | Implemented according to poetry documentation |
| `prerelease` | `prerelease` | Implemented according to poetry documentation |

Hence, replacing `poetry version` with `pdm bump` should be sufficient with pdm-bump v0.8.0 onwards.

## VCS based actions

**NOTE**: Currently, only `git` is supported as VCS provider.
Expand Down

0 comments on commit 336a786

Please sign in to comment.