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

GitHub helper without token for issues #44

Open
yarikoptic opened this issue Mar 19, 2019 · 5 comments
Open

GitHub helper without token for issues #44

yarikoptic opened this issue Mar 19, 2019 · 5 comments

Comments

@yarikoptic
Copy link

Token generation is not rocket science but still might be a stumbling point for some users.
I believe it is possible to just fire up the browser with a url feeding encoded summary and description:
https://help.github.com/en/articles/about-automation-for-issues-and-pull-requests-with-query-parameters
I am using a tiny helper of a similar kind to submit a new PR, http://git.onerussian.com/?p=etc/bash.git;a=blob;f=.bash/bashrc/30_aliases_sh;hb=HEAD#l963 even though nothing fancy - no description etc - relying on GitHub.
That would also allow the user to review the issue content before hitting submit.

@vsoch
Copy link
Owner

vsoch commented Mar 19, 2019

Help me works well now to submit issues, it’s fairly straight forward to see what you write, and I don’t think it’s overkill to export a token just once. I’m not totally clear on what you are suggesting to do but it sounds a bit like over engineering. Perhaps you can better describe the issue you think needs fixing and why this approach is fitting?

@yarikoptic
Copy link
Author

I would not say it would "fix" a specific issue, but

  • helpme provides only basic editing functionality so it is unlikely anyone would compose detailed issue description in the interactive mode of helpme
  • there is no markdown "Preview" as provided by github web UI which could be utilized before actually submitting the issue to verify that all is looking good
  • there is no lookup for other issues among existing on github, so submitting duplicate issues is more likely than when filing an issue on github
  • it requires a token (to fully automagically submit an issue) whenever it could be avoided with minimal interaction of the user with github in a browser
  • If helpme to be "integrated" within some project, e.g. datalad, where might give an option to invoke smth like helpme github datalad/datalad upon unexpected crash of datalad, we would now need first to request a token to be provided, so many users would need first to go get it, and might just discard the idea of submitting an issue altogether. (BTW in datalad we rely on hub.oauthtoken git config variable to provide such a token, so may be, if git is installed, it could be looked up/offered to be used if there is no HELPME_GITHUB_TOKEN? just an idea)
  • If invoked as a result of an error, we also would like capture traceback information, the datalad WTF to be embedded within foldable <details><summary>...</summary> WTF body</details>, etc. It would be valuable to let user review, possibly sanitize and extend the full body of the issue in a more or less full featured editor before actually submitting. Since GitHub sends out notifications to developers upon new issues filed, it is not exactly replaceable with "submit first and then edit online later".

So overall -- I am whining to not really "fix" any specific issue, but just was thinking that may be helpme could "integrate" with github web UI, and as a result to simplify interactions with the user. Just an idea, comes for free, feel free to ignore/close ;-)

@vsoch
Copy link
Owner

vsoch commented Dec 16, 2019

@yarikoptic can you tell me more about hub.oauthtoken?

@yarikoptic
Copy link
Author

@yarikoptic can you tell me more about hub.oauthtoken?

It is a "convention" by https://github.com/sociomantic-tsunami/git-hub to store token in git configuration. @mih added it initially awhile back in datalad as the way to specify the token for datalad create-sibling-github command. Since then it became a bit more "flexible" so it would do 2FA etc. and then ask user where to save the token under that configuration variable: https://github.com/datalad/datalad/blob/master/datalad/support/github_.py#L235

@vsoch
Copy link
Owner

vsoch commented Dec 18, 2019

This will be closed by #49

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants