Skip to content

Commit 8942f62

Browse files
committed
docs: add instructions of semantic versioning
1 parent ea21a76 commit 8942f62

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,18 @@ as well as its correspondent options.
166166
python cli.py gen_swagger_json -f ~/Downloads/swagger.json
167167
```
168168

169+
## Semantic versioning
170+
171+
### Style
172+
We use [angular commit message style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) as the standard commit message style.
173+
174+
### Release
175+
1. A Release can be done manually or automatically using CI, in either case the variable `GH_TOKEN` is required
176+
to post releases to Github. The `GH_TOKEN` can be generated following [these steps](https://help.github.com/es/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)
177+
178+
2. We use the command `semantic-release publish` after a successful PR to make a release. Check the library
179+
[python-semantic-release](https://python-semantic-release.readthedocs.io/en/latest/commands.html#publish) for details of underlying operations.
180+
169181
## Run as docker container
170182
1. Build image
171183
```bash

0 commit comments

Comments
 (0)