esnunes / github-apps

Workshop: How to build your first GitHub App

How to build your first GitHub App

Workshop Pre-requisites • Useful links • Workshop steps • Extend your app further

---

Workshop Pre-requisites

• A GitHub.com account

Useful links throughout the workshop

• Creating an issue comment
  • API documentation: https://developer.github.com/v3/issues/comments/#create-a-comment
  • Node SDK: https://octokit.github.io/rest.js/#octokit-routes-issues-create-comment
• Creating a check run
  • API documentation: https://developer.github.com/v3/checks/runs/#create-a-check-run
  • Node SDK: https://octokit.github.io/rest.js/#octokit-routes-checks-create
• Getting a single file
  • API documentation: https://developer.github.com/v3/repos/contents/#get-contents
  • Node SDK: https://octokit.github.io/rest.js/#octokit-routes-repos-get-contents
• Page where you can view and re-deliver webhooks: https://github.com/settings/apps/your-app-name/advanced

Follow along live: [Link to come in the workshop]

Workshop steps

1. Fork the satelliteworkshops/app-playground repo to your personal account
2. Enable "Issues" for the forked repo via the repo settings
3. Create your Glitch app by following this link: https://glitch.com/edit/#!/remix/satellite-workshop-github-apps-start
4. Wait for Glitch to load and for it to install all the dependencies. You can see progress by clicking on "Tools" and then "Logs" in the bottom left corner
5. Click the "Show" button at the top of the page. A new tab should open and the page should have a "Register GitHub App" button
6. Click the "Register GitHub App" button and choose a name for your GitHub App. A GitHub app will be created for you in the background. Once it is complete you will see a new page that asks you where you want to install your new app.
7. On this page, select the "Only select repositories" and in the dropdown choose the "app-playground" repository that you forked in step 1.
8. In your current tab, go to the app-playground repository. It should be at github.com/your-username/app-playground
9. Then head back to Glitch, it's time to write some code!

Extend and improve your app further

• Support multiple changing dependencies in a single pull request
• Show license information as part of the annotation
• Customise warning/notices
• Add an "action button" to let the legal team “approve" the dependency changes
• Modify the check “conclusion” based on the changed dependencies
• Experiment further with all the other APIs and build something completely different