Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dsfinn/roboversion
Automated project versioning based on Git repository state
https://github.com/dsfinn/roboversion
development-tools git python python3 python36 versioning
Last synced: about 21 hours ago
JSON representation
Automated project versioning based on Git repository state
- Host: GitHub
- URL: https://github.com/dsfinn/roboversion
- Owner: dsfinn
- License: gpl-3.0
- Created: 2019-04-21T04:06:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-10T11:46:47.000Z (almost 5 years ago)
- Last Synced: 2024-08-31T15:21:23.280Z (about 1 month ago)
- Topics: development-tools, git, python, python3, python36, versioning
- Language: Python
- Size: 83 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# roboversion
Automated project versioning based on Git repository state.
[](https://gitlab.com/dsfinn/roboversion/commits/master)
[](https://gitlab.com/dsfinn/roboversion/commits/master)
## Author
David Finn: [email protected]
## Requirements
* Python 3.6+
* Git
## Installation
```sh
pip install roboversion
```
## Quickstart
roboversion trivialises versioning for packaging in `setup.py`:
```python
from setuptools import setup
from roboversion import get_version
...
setup(
...
version=str(get_version(alpha_branch='origin/my_alpha_branch')),
...
)
```
Beyond tagging release commits as normal, this might be the only time the
developer needs to touch versioning for their project at all.
## Description
Running this module, or its `get_version` function, will inspect the specified
Git repository state and construct a corresponding PEP440-compliant version.
Base releases are expected to be tagged as PEP440-compliant version strings.
If no version tags exist, the base version will be treated as `0.0.0`, and the
resulting development version will be targeting release `0.0.1`.
If prerelease branches are specified (e.g. alpha, beta, release candidate)
the output version will reflect this information based on the closest ancestor
prerelease branch.
## Use
This module can be used as an imported module or directly from the command
line.
If no ref is specified as the target, 'HEAD' will be the target ref.
If the ref is tagged with a version, the version will correspond to
the tagged version.
If the current branch is a prerelease branch, the version will
will be a corresponding prerelease version of the next release.
If the ref is neither a tagged version nor at a prerelease branch,
the version will be a development version of the next upstream
prerelease branch. If no prerelease branches are specified, the version
will be a development version of the next release.
If the ref is in the history of an upstream prerelease branch, the
version will be a local version of the last release. This is unlikely to be
useful, and probably the result of a misconfiguration.
Detailed descriptions of parameters can be found in the method documentation
and by running the module with `--help`.
## Examples
```python
from roboversion import get_version
...
version = get_version()
```
```python
from roboversion import get_version
...
version = get_version(alpha_branch='origin/my_alpha_branch')
```
```bash
$ roboversion
```
```bash
$ roboversion /path/to/repository
```
```bash
$ roboversion --ref origin/master
```
```bash
$ roboversion --alpha origin/alpha --beta origin/beta --release origin/release --no-auto-local --ref HEAD
```
```bash
$ python -m roboversion --alpha origin/alpha --beta origin/beta --release origin/release --no-auto-local --ref HEAD
```