Markdown Cleanup Github Bot - Revision history

Admin: /* Procedure */

2018-08-05T03:57:30Z

Procedure

← Older revision		Revision as of 03:57, 5 August 2018
Line 42:		Line 42:
	Log in as bot @embarcaderomindmachine		Log in as bot @embarcaderomindmachine

	We will need to make an OAuth application as @embarcaderomindmachine. That requires us to have an endpoint for the bot.		We will need to make an OAuth application as @embarcaderomindmachine.
			* That requires us to have an endpoint for the bot.
			* That requires a url endpoint, and that requires https, and that requires a domain. So complicated.
			* (Alternatively, could set up a localhost endpoint.)

	~~That requires~~ a ~~url~~ endpoint, ~~and that requires https, and that requires a domain. So complicated. (Alternatively, could set up a localhost endpoint~~.)		Once we have a URL endpoint, we'll create our OAuth application.

	===Examples===		===Examples===

Admin: /* Procedure */

2018-08-05T03:56:49Z

Procedure

← Older revision		Revision as of 03:56, 5 August 2018
Line 43:		Line 43:

	We will need to make an OAuth application as @embarcaderomindmachine. That requires us to have an endpoint for the bot.		We will need to make an OAuth application as @embarcaderomindmachine. That requires us to have an endpoint for the bot.

			That requires a url endpoint, and that requires https, and that requires a domain. So complicated. (Alternatively, could set up a localhost endpoint.)

	===Examples===		===Examples===

Admin: /* Related */

2018-08-05T03:28:41Z

← Older revision		Revision as of 03:28, 5 August 2018
Line 66:		Line 66:
	[[Category:CI]]		[[Category:CI]]
	[[Category:Github]]		[[Category:Github]]
	[[Category:~~Bot~~]]		[[Category:Bots]]

Admin: /* Related */

2018-08-05T03:28:24Z

← Older revision		Revision as of 03:28, 5 August 2018
Line 60:		Line 60:

	Also see [[DIY CI]]		Also see [[DIY CI]]




			[[Category:CI]]
			[[Category:Github]]
			[[Category:Bot]]

Admin: /* In Practice */

2018-08-05T03:13:09Z

In Practice

← Older revision		Revision as of 03:13, 5 August 2018
Line 38:		Line 38:
	'''Question:''' more graceful way to install/uninstall webhooks? Automated removal when permission revoked? What if webhook still installed??		'''Question:''' more graceful way to install/uninstall webhooks? Automated removal when permission revoked? What if webhook still installed??

			===Procedure===

			Log in as bot @embarcaderomindmachine

			We will need to make an OAuth application as @embarcaderomindmachine. That requires us to have an endpoint for the bot.

	===Examples===		===Examples===

Admin: /* In Practice */

2018-08-05T02:52:52Z

In Practice

← Older revision		Revision as of 02:52, 5 August 2018
Line 24:		Line 24:
	===In Practice===		===In Practice===

	~~Let~~'~~s try this out in practice~~.		I mention @embarcaderomindmachine in a PR thread, and get a response from @embarcaderomindmachine. We'll call it the embarcadero chat bot.

	I want ~~to be able to mention @embarcaderomindmachine in an issues/PR thread, and get a response from @embarcaderomindmachine~~.		Simple enough - you install a webhook endpoint into whatever repo you want.

	~~Simple enough - how do we get started?~~		To script the installation of a webhook: edit config file and add the name of the repo that you as a random user administer and wish to install embarcadero chat bot into. run the install webhook script as that user with a github access token from that user. (COMPLETELY standalone script. separation of credentials.)

	@embarcaderomindmachine needs to be notified of events that are relevant. that means creating a webhook endpoint that is for embarcaderomindmachine, that is continuously listening, and when it receives webhoooks, it ~~will take an action~~.		(Shoot, you could probably make the OAuth app do it.)

	~~====Questions====~~		Once the webhook is installed, any events in the repo are sent to the webhook, and it sniffs out pull request events. When pull request events come in, the embarcadero chat bot checks if it's a comment, and if it contains @embarcaderomindmachine. If it does, it responds as @embarcaderomindmachine. Then it logs that it has responded to that comment.

	~~Ideally, a given oauth application would install itself as a webhook in your repository. I think that~~'~~s possible to ask~~ permission to ~~do via API~~, ~~but is this really how it needs to be done? Also what happens when you revoke permission? The webhook is still installed... right~~?		'''Question:''' Why is @embarcaderomindmachine granted permission to access a private repo, just because the OAuth application was?

	~~We should have a better~~ way ~~of automating this.~~		'''Question:''' more graceful way to install/uninstall webhooks? Automated removal when permission revoked? What if webhook still installed??


			===Examples===

	example here: https://github.com/yiisoft-contrib/github-bot		example here: https://github.com/yiisoft-contrib/github-bot

Admin: /* Questions */

2018-08-05T01:31:03Z

Questions

← Older revision		Revision as of 01:31, 5 August 2018
Line 39:		Line 39:

	example here: https://github.com/yiisoft-contrib/github-bot		example here: https://github.com/yiisoft-contrib/github-bot

	* this uses a "register" and "unregister" action model		* this uses a "register" and "unregister" action model
	* it does use the API to install hooks into a repo		* it does use the API to install hooks into a repo

Admin: /* In Practice */

2018-08-05T01:30:20Z

In Practice

← Older revision		Revision as of 01:30, 5 August 2018
Line 26:		Line 26:
	Let's try this out in practice.		Let's try this out in practice.

	I want to be able to mention @embarcaderomindmachine in an issues/PR thread, and get a response from @embarcaderomindmachine~~. Simple enough~~.		I want to be able to mention @embarcaderomindmachine in an issues/PR thread, and get a response from @embarcaderomindmachine.

			Simple enough - how do we get started?

			@embarcaderomindmachine needs to be notified of events that are relevant. that means creating a webhook endpoint that is for embarcaderomindmachine, that is continuously listening, and when it receives webhoooks, it will take an action.

			====Questions====

			Ideally, a given oauth application would install itself as a webhook in your repository. I think that's possible to ask permission to do via API, but is this really how it needs to be done? Also what happens when you revoke permission? The webhook is still installed... right?

			We should have a better way of automating this.

			example here: https://github.com/yiisoft-contrib/github-bot
			* this uses a "register" and "unregister" action model
			* it does use the API to install hooks into a repo
			* also (responsibly) implements an uninstall hooks method

	===Links===		===Links===

Admin: /* Notes */

2018-08-04T19:46:27Z

Notes

← Older revision		Revision as of 19:46, 4 August 2018
Line 21:		Line 21:
	* Does the OAuth application simply need to request write permission for repos?		* Does the OAuth application simply need to request write permission for repos?
	* Can the owner of the OAuth application then do what they'd like? Do the changes show up under the account of the OAuth application's owner?		* Can the owner of the OAuth application then do what they'd like? Do the changes show up under the account of the OAuth application's owner?

			===In Practice===

			Let's try this out in practice.

			I want to be able to mention @embarcaderomindmachine in an issues/PR thread, and get a response from @embarcaderomindmachine. Simple enough.

Admin: /* Notes */

2018-08-04T19:44:18Z

Notes

← Older revision		Revision as of 19:44, 4 August 2018
Line 3:		Line 3:
	==Notes==		==Notes==

	===~~The~~ Theory===		===In Theory===

	Here's how this thing works, in theory:		Here's how this thing works, in theory anyway:

	* First, you set up a Github bot account - the user that will do your bidding.		* First, you set up a Github bot account - the user that will do your bidding.
Line 11:		Line 11:
	* This is still totally unclear.		* This is still totally unclear.

	~~Useful: PR request hook (flask server) that comments on PRs from first-time contributors~~
	* https://github.com/Deborah-Digges/pr-bot

	How it works:		How it works:
	* Run the flask app somewhere (self-hosted, heroku, google app engine)		* Run the flask app somewhere (self-hosted, heroku, google app engine)
	* Install a webhook in your repo that pings the endpoint, and only do on pull request events		* Install a webhook in your repo that pings the endpoint, and only do on pull request events

			Why I'm still confused:
			* The OAuth application has an "owner" and it has "users"
			* We're trying to build a bot that can comment on pull requests in private repositories
			* Does the OAuth application simply need to request write permission for repos?
			* Can the owner of the OAuth application then do what they'd like? Do the changes show up under the account of the OAuth application's owner?


			===Links===

			Useful: PR request hook (flask server) that comments on PRs from first-time contributors
			* https://github.com/Deborah-Digges/pr-bot

	==Related==		==Related==

	Also see [[DIY CI]]		Also see [[DIY CI]]