Project Planning: Use Case Templates

Proposal: Use Case Templates

The original proposal for this idea lives here https://github.com/probot/probot/issues/620 and contains more details about potential examples for these templates.

When folks start building Probot Apps, sometimes they already know the kind of thing they want to build with the GitHub API. We’ve identified several patterns or APIs that are commonly used and want to implement some basic examples for folks to get that work out of the box. And by out of the box, we mean you could optionally select one of these ‘templates’ when running create-probot-app.

This project proposal reflects the sub-tasks of this project card from our org-wide roadmap which is designed to reflect our larger goals.

Tasks

In order to better understand what this project will look like, I’m breaking it down into more actionable tasks as follows:

• Create and implement a plan for storing the various templates and how the create-probot-app script will access them. See https://github.com/probot/create-probot-app/issues/34 for more details
  • Merge template examples from https://github.com/probot/template/pull/79 into create-probot-app
  • Update the script in create-probot-app to use those folders for installation
    • Potentially update this npm module to work for folders
• Write the code for each use case example
  • Basic (commenting on new issues) JS
  • Basic TS
  • Checks API JS
  • Git Data API JS
  • Deployments API JS
• Write working tests for each use case example
  • Basic (commenting on new issues) JS
  • Basic TS
  • Checks API JS
  • Git Data API JS
  • Deployments API JS
  • Probably a good opportunity to update our testing docs - PR: https://github.com/probot/probot/pull/734
• Actually test the script and the templates some-how, see https://github.com/probot/template/pull/77 for 💭
• Documentation updates
  • development docs to reflect the new use cases
  • create-probot-app readme/repo
  • npm module docs
• Cut a release of the create-probot-app npm module

cc/ @probot/maintainers

[hiimbex]

I just published https://www.npmjs.com/package/create-probot-appz as an early release of this work, please feel free to create some apps with it and test out the templates!

Try running any of the following to test out different apps!

npx create-probot-appz my-first-app -t basic-js
npx create-probot-appz my-first-app -t basic-ts
npx create-probot-appz my-first-app -t checks-js
npx create-probot-appz my-first-app -t git-data-js
npx create-probot-appz my-first-app -t deploy-js

Feedback welcome. 🙇‍♀️

cc/ @probot/maintainers

<div> npm</div><div>create-probot-appz</div><div>Create a Probot app</div>

[MaximDevoir]

Development docs have since been updated to reflect Create Probot App’s template cases in 5443ce03c8fac0a1c180a36f4a78ab4981829e92.

The final 2 tasks can be checks off and this issue closed. Additionally, this card moved to done (although it appears to have been a while since the project was last updated).