Skip to main content

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
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sib-commit-parser-0.2.2.tar.gz (2.5 kB view hashes)

Uploaded Source

Built Distribution

sib_commit_parser-0.2.2-py3-none-any.whl (2.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page