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

feat: GitHub Issue Bot function #6

Merged
merged 13 commits into from
Aug 1, 2023
130 changes: 130 additions & 0 deletions node/github-issue-bot/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
6 changes: 6 additions & 0 deletions node/github-issue-bot/.prettierrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"trailingComma": "es5",
"tabWidth": 2,
"semi": true,
"singleQuote": true
}
67 changes: 67 additions & 0 deletions node/github-issue-bot/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
# 🤖 Node.js GitHub Issue Bot Function

Automate the process of responding to newly opened issues on a GitHub repository.

## 🧰 Usage

### `POST`

Handles webhook and returns a verification response.

**Parameters**

| Name | Description | Location | Type | Sample Value |
| ------------------- | ------------------------- | -------- | ------ | ----------------------------------------------------------------------------------------------------- |
| x-hub-signature-256 | GitHub webhook signature | Header | String | `h74ba0jbla01lagudfo` |
| x-github-event | GitHub webhook event type | Header | String | `issues` |
| JSON Body | GitHub webhook payload | Body | Object | See [GitHub docs](https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payload) |

**Response**

Sample `200` Response:

Webhook verification successful.

```json
{ "ok": true }
```

Sample `401` Response:

Webhook verification failed.

```json
{ "ok": false, "error": "Invalid signature" }
```

## ⚙️ Configuration

| Setting | Value |
| ----------------- | ------------- |
| Runtime | Node (18.0) |
| Entrypoint | `src/main.js` |
| Build Commands | `npm install` |
| Permissions | `any` |
| Timeout (Seconds) | 15 |

## 🔒 Environment Variables

### GITHUB_WEBHOOK_SECRET

The secret used to verify that the webhook request comes from GitHub.

| Question | Answer |
| ------------- | ----------------------------------------------------------------------------------------------- |
| Required | Yes |
| Sample Value | `d1efb...aec35` |
| Documentation | [GitHub Docs](https://docs.github.com/en/developers/webhooks-and-events/securing-your-webhooks) |

### GITHUB_TOKEN

A personal access token from GitHub with the necessary permissions to post comments on issues.

| Question | Answer |
| ------------- | ---------------------------------------------------------------------------------------------------------- |
| Required | Yes |
| Sample Value | `ghp_1...` |
| Documentation | [GitHub Docs](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) |
10 changes: 10 additions & 0 deletions node/github-issue-bot/env.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
declare global {
namespace NodeJS {
interface ProcessEnv {
GITHUB_TOKEN: string;
GITHUB_WEBHOOK_SECRET: string;
}
}
}

export {};
Loading