Skip to content
This repository has been archived by the owner on May 16, 2022. It is now read-only.

Commit

Permalink
Correct typos and Add exception of config file not found
Browse files Browse the repository at this point in the history
  • Loading branch information
shresthagrawal committed Mar 18, 2019
1 parent 14312c3 commit f14d5ff
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Sample config named [release-conf-example.yaml](release-conf-example.yaml) can b

## GitChangeLog

For using the [gitchangelog](https://github.com/vaab/gitchangelog) you must add the line `gitchanelog = true` to the conf.yaml, and add the files `.gitchangelog.rc` and `markdown.tpl` in the root of your upstream project repository. Sample config files: [.gitchangelog.rc](/gitchangelog/.gitchangelog.rc) and [template.tpl](/gitchangelog/template.tpl).
For using the [gitchangelog](https://github.com/vaab/gitchangelog) you must add the line `gitchanelog: true` to the conf.yaml, and add the files `.gitchangelog.rc` and `markdown.tpl` in the root of your upstream project repository. Sample config files: [.gitchangelog.rc](/gitchangelog/.gitchangelog.rc) and [template.tpl](/gitchangelog/template.tpl).

`.gitchangelog.rc` sample is heavily commented and should be enough to make modification but for specific details you can refer to the original [repository](https://github.com/vaab/gitchangelog).
The default template `markdown.tpl` is configured to create Markdown divided into sections (New, Changes, Fix, Others) based on the commits. The data sent to the output engine [pystache](https://github.com/defunkt/pystache) by the gitchangelog is in the following [format](https://github.com/vaab/gitchangelog/edit/master/README.rst#L331-L356). You can use it to create a custom template, please refer [mustache](http://mustache.github.io/).
Expand Down
5 changes: 2 additions & 3 deletions release_bot/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
from pathlib import Path

from release_bot.configuration import configuration
from release_bot.exceptions import ReleaseException


class CLI:
Expand All @@ -39,10 +40,8 @@ def run_bot(args):
if args.configuration:
args.configuration = Path(args.configuration).resolve()
if not args.configuration.is_file():
configuration.logger.error(
raise ReleaseException(
f"Supplied configuration file is not found: {args.configuration}")
exit(1)

if args.debug:
configuration.logger.setLevel(logging.DEBUG)
for key, value in vars(args).items():
Expand Down
2 changes: 1 addition & 1 deletion release_bot/init_repo.py
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ def create_conf(self):
"""
self.conf['repository_name'] = input('Please enter the repository name:')
self.conf['repository_owner'] = input('Please enter the repository owner:')
print("""for details on how to get github token checkou
print("""for details on how to get github token checkout
'https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/'""")
self.conf['github_token'] = input('Please enter your valid github token:')
refresh_interval = input("""In how many seconds would you like the
Expand Down

0 comments on commit f14d5ff

Please sign in to comment.