Commit parser for StartinBlox packages
Project description
# Conventional changelog for Startin'blox
## Commit types
| Commit Type | Title | Description | Release | In changelog |
|:-----------:|------------|-------------------|------------|:------------:|
| `minor` | Minor | Minor release | `minor` | `yes` |
| `major` | Major | Major release | `major` | `yes` |
| `feature` | Features | New behavior | `patch` | `yes` |
| `update` | Updates | Change behavior | `patch` | `yes` |
| `bugfix` | Bug Fixes | Fix bugs | `patch` | `yes` |
| `ui` | Interface | Change appearance | `patch` | `yes` |
| `syntax` | Syntax | Refactoring code | `patch` | `yes` |
| | Other | All others | `patch` | `no` |
[See reference](https://git.happy-dev.fr/startinblox/management#commit-messages)
## Setup
Add the relevant `semantic_release` section to your `setup.cfg`:
```
[semantic_release]
version_variable = myapp/__init__.py:__version__
commit_parser = sib_semantic_release.parser
```
Install the package in your build environment (not working yet!):
```
$ pip install sib-semantic-release
```
FIXME: force installation from specific indexes:
```
$ pip install git+https://github.com/plup/python-semantic-release
$ pip install git+https://git.happy-dev.fr/startinblox/semantic-release-py
```
## Commit types
| Commit Type | Title | Description | Release | In changelog |
|:-----------:|------------|-------------------|------------|:------------:|
| `minor` | Minor | Minor release | `minor` | `yes` |
| `major` | Major | Major release | `major` | `yes` |
| `feature` | Features | New behavior | `patch` | `yes` |
| `update` | Updates | Change behavior | `patch` | `yes` |
| `bugfix` | Bug Fixes | Fix bugs | `patch` | `yes` |
| `ui` | Interface | Change appearance | `patch` | `yes` |
| `syntax` | Syntax | Refactoring code | `patch` | `yes` |
| | Other | All others | `patch` | `no` |
[See reference](https://git.happy-dev.fr/startinblox/management#commit-messages)
## Setup
Add the relevant `semantic_release` section to your `setup.cfg`:
```
[semantic_release]
version_variable = myapp/__init__.py:__version__
commit_parser = sib_semantic_release.parser
```
Install the package in your build environment (not working yet!):
```
$ pip install sib-semantic-release
```
FIXME: force installation from specific indexes:
```
$ pip install git+https://github.com/plup/python-semantic-release
$ pip install git+https://git.happy-dev.fr/startinblox/semantic-release-py
```
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sib_commit_parser-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae22f45ef8ca95f8e582cfeb0b63cbc9ee2346dd6213ef5479567ff6d800871c |
|
MD5 | 554f041f47b2ab4b6eb2360b029791a8 |
|
BLAKE2b-256 | b3939abfd21d665d2137dd4bbf33d80e3a8048907436ce89f07363e4a000943f |