Skip to content

Improve user experience when using this tool as a CLI #36

Description

@fridex

Is your feature request related to a problem? Please describe.

When I tried thoth-glyph, it produced the following output for me:

$ thoth-glyph classify-repo-by-tag  -p /home/fpokorny/git/thoth-station/adviser --start_tag v0.10.0             
2020-08-17 11:23:06,330 379272 WARNING  thoth.common:346: Logging to a Sentry instance is turned off
2020-08-17 11:23:06,330 379272 INFO     thoth.common:368: Logging to rsyslog endpoint is turned off
2020-08-17 11:23:06,331 379272 INFO     glyph:68: Version: 0.1.0
2020-08-17 11:23:06,331 379272 INFO     glyph:121: Classifying commits between given tags
2020-08-17 11:23:06,346 379272 INFO     thoth.glyph.models:44: Model Path : /home/fpokorny/.local/share/virtualenvs/a-EouiYCWm/lib/python3.7/site-packages/thoth/glyph/data/model_commits_v2_quant.bin
Warning : `load_model` does not return WordVectorModel or SupervisedModel any more, but a `FastText` object which is very similar.
2020-08-17 11:23:06,378 379272 INFO     thoth.glyph.models:52: 144 commits classified
                                               message labels_predicted
0    :pushpin: automatic update of dependency matpl...         features
1    :pushpin: automatic update of dependency matpl...         features
2    :pushpin: automatic update of dependency thoth...         features
3    :pushpin: automatic update of dependency thoth...         features
4    adjust message when resolver does not find any...       corrective
..                                                 ...              ...
139  merge branch 'master' into disable-setup-proce...         features
140  merge branch 'master' into disable-setup-proce...         features
141          disable setup.py processing in s2i builds         features
142          merge branch 'master' into platform-check         features
143                add a check for available platforms         features

[144 rows x 2 columns]

Sadly, I see just first 5 commits and last 5 commits classified. It would be nice to produce the whole classification to standard output and let the user (if required) filter messages.

Other suggestions:

  • the output could have the commit sha of the commit being classified

  • the output could be in an easily processable form by tools (e.g. coreutils) by default

  • merge commits could be removed from the output

  • formatter could be selected as a CLI option to have a tool that can be easily used on the command line, e.g.:

    $ pipenv run thoth-glyph classify-repo-by-tag  -p /home/fpokorny/git/thoth-station/adviser --start_tag v0.10.0 --formatter Markdown > CHANGELOG.md
    
  • use dashes instead of underscores in the command-line options

  • improve help messages (e.g. classify sub-command says the classification is done for the current git repo, but it is done for the commit message passed as argument)

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.hacktoberfestIssues targeting the hacktoberfest participants.kind/featureCategorizes issue or PR as related to a new feature.lifecycle/frozenIndicates that an issue or PR should not be auto-closed due to staleness.priority/backlogHigher priority than priority/awaiting-more-evidence.sig/user-experienceIssues or PRs related to the User Experience of our Services, Tools, and Libraries.

    Type

    No type

    Projects

    Status
    🆕 New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions