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 = commit_parse.parse
```
## Test it locally
Force installation from specific indexes:
```
$ pip install git+https://github.com/plup/python-semantic-release
$ pip install git+https://git.happy-dev.fr/startinblox/devops/py-commit-parser
```
Make some commits and simulate release:
```
$ git commit --allow-empty -m 'some stupid message'
$ semantic-release version --noop
Creating new version..
Current version: 0.4.6
No operation mode. Should have bumped from 0.4.6 to 0.4.7
```
## 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 = commit_parse.parse
```
## Test it locally
Force installation from specific indexes:
```
$ pip install git+https://github.com/plup/python-semantic-release
$ pip install git+https://git.happy-dev.fr/startinblox/devops/py-commit-parser
```
Make some commits and simulate release:
```
$ git commit --allow-empty -m 'some stupid message'
$ semantic-release version --noop
Creating new version..
Current version: 0.4.6
No operation mode. Should have bumped from 0.4.6 to 0.4.7
```
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.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7f6d7b088770bd522b3ea7c0b29ef8dd1a44e75247dd93e5c43954a7862aff5 |
|
MD5 | b3d7ac7e689ead5a8e073859a4ef7916 |
|
BLAKE2b-256 | 7e73b3f7e598e3eb1f3c5a9d179a7ceb89f94e22a1c14b63f96054362159c347 |