wei / github-project-notifier

A Discord 🤖 that notifies on GitHub Project Card updates

Never miss updates on your GitHub Projects again~

It is easy to overlook activities in GitHub Projects. GitHub Project Notifier helps you and your collaborators keep track of any project card updates on your project channels in Discord!

Usage

1. Install GitHub Project Notifier GitHub App onto your project repositories.
2. Add GitHub Project Notifier Discord Bot to your server.

Note

• This app only works with GitHub Projects (classic).
• Please self-host the application.

Commands

• list: Lists all subscribed GitHub Project boards
  • !github-project list
• sub: Subscribe to a GitHub Project board
  • !github-project sub https://github.com/[owner]/[repo]/projects/[0-9]+
• unsub: Unsubscribe from a GitHub Project board
  • !github-project unsub https://github.com/[owner]/[repo]/projects/[0-9]+

Examples

Self-host

Please read CONTRIBUTING.md for detailed instructions.

License

This project is developed as part of MLH Fellowship Halfway Hackathon and licensed under MIT

github-project-notifier's Issues

Create Submission on Devpost

Download png for devpost: https://socialify.git.ci/wei/github-project-notifier?description=1&font=Bitter&logo=https%3A%2F%2Fdiscord.com%2Fassets%2Ff8389ca1a741a115313bede9ac02e2c0.svg&pattern=Formal%20Invitation&theme=Light

Support Projects under Organization

Tasks

1. Set up GitHub App at https://github.com/settings/apps/new with webhook url, Projects permission under BOTH Repository and Organization
   • Create a GitHub organization, add a project board, and install this app to it.
2. Migrate to either octokit/app or probot for listening to webhooks, remove fastify
   • https://github.com/octokit/app.js/
   • or
   • https://probot.github.io/docs/webhooks/
3. octokit/rest can be removed from project
   • remove the need for GITHUB_TOKEN as token and authentications are handled by Step 2.
4. Update references to repository in prepareMessage, for events from organization project boards, the webhook will not include a repository instead, it will include a organization. So use the organization name in the footer instead of repo name.
5. Update CONTRIBUTING.md with steps to set up a github app and add private key, secrets, etc.

Video Post-processing

Post-process videos and upload to YouTube or Vimeo. Please upload the link in devpost submission

Discord command handlers

Complete command handlers in https://github.com/wei/github-project-notifier/tree/master/commands

Blocked by #2.

Connect datastore

Implement Add/Delete/Query methods in https://github.com/wei/github-project-notifier/blob/master/datastore/index.js

Draft README

Draft README and devpost.

Create GitHub App for installing webhooks

Instead of manually installing webhooks in settings

Demo video

We should get together and discuss what goes into the demo video.

Perhaps

1. Introduction, elevator pitch
2. Each team member introduces themselves and which component of the project was worked on
3. Demo

Set up bot deployment

Is the service offline?

I added the service and the bot to my account as it described in readme.md. But GitHub Project Notifier#1101 stays offlline, doesn't response to any command and doesn't send notifications.

Prepare Discord Message from Webhook Payload

File: https://github.com/wei/github-project-notifier/blob/master/webhook/prepare-message.js

1. Process payload. Can be created, edited, moved, converted, or deleted. GitHub Webhook: docs

2. Get githubProjectUrl using octokit.projects.get({ project_id }) it's under html_url field. Octokit rest.js: docs

3. If content_url is not available (I think it's only available for issues added directly to project board), Parse issue/pr shorthand to get repo and issue number.

   e.g.

   • facebook/react#1
   • facebook/react/issues/1
   • facebook/react/pull/1
   • https://github.com/facebook/react/issues/1
   • https://github.com/facebook/react/pull/1

4. Get issue/pr title using Octokit, prs can be retrieved using the octokit.issues.get too

   await octokit.issues.get({
     owner,
     repo,
     issue_number,
   });
   

5. Column names can be retrieved using octokit.projects.getColumn({ column_id }) with payload.project_card.column_id

6. Draft and style MessageEmbed for each action type. MessageEmbed: docs