Skip to content

Add semantic versioning #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 8, 2020
Merged

Add semantic versioning #71

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ea21a76
feat: add python-semantic-release library
Angeluz-07 Apr 8, 2020
8942f62
docs: add instructions of semantic versioning
Angeluz-07 Apr 8, 2020
5adc318
refactor: update app version
Angeluz-07 Apr 8, 2020
6b55e05
fix: add missing dependency in dockerfile
Angeluz-07 Apr 8, 2020
65fe776
docs: add CI link in README.md
Angeluz-07 Apr 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs: add instructions of semantic versioning
  • Loading branch information
@Angeluz-07
Angeluz-07 committed Apr 8, 2020
commit 8942f62ac300960a49ac80e7650d5637a8beacf1
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,18 @@ as well as its correspondent options.
python cli.py gen_swagger_json -f ~/Downloads/swagger.json
```

## Semantic versioning

### Style
We use [angular commit message style](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits) as the standard commit message style.

### Release
1. A Release can be done manually or automatically using CI, in either case the variable `GH_TOKEN` is required
Copy link
Contributor

@EliuX EliuX Apr 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say that

The release is automatically done by the TimeTracker CI. The variable GH_TOKEN is required...

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)
Copy link
Contributor

@EliuX EliuX Apr 8, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing last point: .


2. We use the command `semantic-release publish` after a successful PR to make a release. Check the library
[python-semantic-release](https://python-semantic-release.readthedocs.io/en/latest/commands.html#publish) for details of underlying operations.

## Run as docker container
1. Build image
```bash
Expand Down