Skip to content
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.

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

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

Open
6 tasks
fridex opened this issue Aug 17, 2020 · 8 comments
Open
6 tasks

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

fridex opened this issue Aug 17, 2020 · 8 comments
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. hacktoberfest Issues targeting the hacktoberfest participants. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries.

Comments

@fridex
Copy link
Contributor

fridex commented Aug 17, 2020

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)

@fridex fridex added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Aug 27, 2020
@sesheta sesheta added kind/feature Categorizes issue or PR as related to a new feature. and removed enhancement labels Jan 28, 2021
@sesheta
Copy link
Member

sesheta commented Apr 28, 2021

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@sesheta sesheta added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 28, 2021
@fridex
Copy link
Contributor Author

fridex commented Apr 29, 2021

/remove-lifecycle stale

@sesheta sesheta removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 29, 2021
@sesheta
Copy link
Member

sesheta commented Jul 15, 2021

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

@sesheta sesheta added the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Jul 15, 2021
@sesheta
Copy link
Member

sesheta commented Aug 23, 2021

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

/lifecycle rotten

@goern goern added the hacktoberfest Issues targeting the hacktoberfest participants. label Sep 15, 2021
@goern
Copy link
Member

goern commented Sep 27, 2021

/priority backlog
/remove-lifecycle rotten

@sesheta sesheta added priority/backlog Higher priority than priority/awaiting-more-evidence. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Sep 27, 2021
@codificat
Copy link
Member

/sig user-experience

@sesheta sesheta added the sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries. label Nov 23, 2021
@sesheta
Copy link
Member

sesheta commented Feb 21, 2022

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

/lifecycle stale

@sesheta sesheta added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Feb 21, 2022
@goern
Copy link
Member

goern commented Mar 2, 2022

/remove-lifecycle stale
/lifecycle frozen

@sesheta sesheta added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Mar 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. hacktoberfest Issues targeting the hacktoberfest participants. kind/feature Categorizes issue or PR as related to a new feature. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. priority/backlog Higher priority than priority/awaiting-more-evidence. sig/user-experience Issues or PRs related to the User Experience of our Services, Tools, and Libraries.
Projects
Status: 🆕 New
Development

No branches or pull requests

4 participants