Skip to content

Commit

Permalink
Update usage docs in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
relekang committed Jul 27, 2015
1 parent 1554051 commit 1f753e6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
14 changes: 13 additions & 1 deletion README.md
Expand Up @@ -13,7 +13,19 @@ pip install python-semantic-release
The general idea is to have some sort of tag in commit messages that indicates certain types of changes.
If a commit message lack a tag it is ignored. Running release can be run locally or from a CI service.

Creating a new release: `$ semantic-release version`
```
Usage: semantic-release [OPTIONS] COMMAND
Options:
--major Force major version.
--minor Force minor version.
--patch Force patch version.
--help Show this message and exit.
```

### Commands

* `version` - Create a new release. Will change the version and commit it.

### Configuration
All configuration described here belongs in `setup.cfg` in a section: `semantic-release`.
Expand Down
6 changes: 3 additions & 3 deletions semantic_release/cli.py
Expand Up @@ -7,9 +7,9 @@

@click.command()
@click.argument('command')
@click.option('--major', 'force_level', flag_value='major')
@click.option('--minor', 'force_level', flag_value='minor')
@click.option('--patch', 'force_level', flag_value='patch')
@click.option('--major', 'force_level', flag_value='major', help='Force major version.')
@click.option('--minor', 'force_level', flag_value='minor', help='Force minor version.')
@click.option('--patch', 'force_level', flag_value='patch', help='Force patch version.')
def main(command, **kwargs):
globals()[command](**kwargs)

Expand Down

0 comments on commit 1f753e6

Please sign in to comment.