Skip to content

Commit

Permalink
docs: added docs on how to bump the version
Browse files Browse the repository at this point in the history
  • Loading branch information
joeyaurel committed Aug 7, 2020
1 parent 508e385 commit 2a55af2
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,33 @@ the `repository-url` is `https://upload.pypi.org/legacy/`.
>
> `pipenv run twine upload --repository-url https://upload.pypi.org/legacy/ dist/*`
## Version bumping (releasing)

All of the following will generate a `<major>.<minor>.<patch>-dev<build>` version:

```bash
# Major
pipenv run bumpversion major --message 'chore: release {new_version}'

# Minor
pipenv run bumpversion minor --message 'chore: release {new_version}'

# Patch
pipenv run bumpversion patch --message 'chore: release {new_version}'
```

To bump up the `<build>` number, run the following:

```bash
pipenv run bumpversion build --message 'chore: release {new_version}'
```

To do a final release of the current `<major>.<minor>.<patch>` part, run the following:

```bash
pipenv run bumpversion release --message 'chore: release {new_version}'
```

## History

This module was originally based on a GEDCOM parser written by
Expand Down

0 comments on commit 2a55af2

Please sign in to comment.