Skip to content

Commit 50d782f

Browse files
authored
Merge pull request #6 from appwrite/feat-github-bot
feat: GitHub Issue Bot function
2 parents 97d63b7 + 3105a80 commit 50d782f

File tree

9 files changed

+591
-0
lines changed

9 files changed

+591
-0
lines changed

node/github-issue-bot/.gitignore

Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
.pnpm-debug.log*
9+
10+
# Diagnostic reports (https://nodejs.org/api/report.html)
11+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
12+
13+
# Runtime data
14+
pids
15+
*.pid
16+
*.seed
17+
*.pid.lock
18+
19+
# Directory for instrumented libs generated by jscoverage/JSCover
20+
lib-cov
21+
22+
# Coverage directory used by tools like istanbul
23+
coverage
24+
*.lcov
25+
26+
# nyc test coverage
27+
.nyc_output
28+
29+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
30+
.grunt
31+
32+
# Bower dependency directory (https://bower.io/)
33+
bower_components
34+
35+
# node-waf configuration
36+
.lock-wscript
37+
38+
# Compiled binary addons (https://nodejs.org/api/addons.html)
39+
build/Release
40+
41+
# Dependency directories
42+
node_modules/
43+
jspm_packages/
44+
45+
# Snowpack dependency directory (https://snowpack.dev/)
46+
web_modules/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Optional stylelint cache
58+
.stylelintcache
59+
60+
# Microbundle cache
61+
.rpt2_cache/
62+
.rts2_cache_cjs/
63+
.rts2_cache_es/
64+
.rts2_cache_umd/
65+
66+
# Optional REPL history
67+
.node_repl_history
68+
69+
# Output of 'npm pack'
70+
*.tgz
71+
72+
# Yarn Integrity file
73+
.yarn-integrity
74+
75+
# dotenv environment variable files
76+
.env
77+
.env.development.local
78+
.env.test.local
79+
.env.production.local
80+
.env.local
81+
82+
# parcel-bundler cache (https://parceljs.org/)
83+
.cache
84+
.parcel-cache
85+
86+
# Next.js build output
87+
.next
88+
out
89+
90+
# Nuxt.js build / generate output
91+
.nuxt
92+
dist
93+
94+
# Gatsby files
95+
.cache/
96+
# Comment in the public line in if your project uses Gatsby and not Next.js
97+
# https://nextjs.org/blog/next-9-1#public-directory-support
98+
# public
99+
100+
# vuepress build output
101+
.vuepress/dist
102+
103+
# vuepress v2.x temp and cache directory
104+
.temp
105+
.cache
106+
107+
# Docusaurus cache and generated files
108+
.docusaurus
109+
110+
# Serverless directories
111+
.serverless/
112+
113+
# FuseBox cache
114+
.fusebox/
115+
116+
# DynamoDB Local files
117+
.dynamodb/
118+
119+
# TernJS port file
120+
.tern-port
121+
122+
# Stores VSCode versions used for testing VSCode extensions
123+
.vscode-test
124+
125+
# yarn v2
126+
.yarn/cache
127+
.yarn/unplugged
128+
.yarn/build-state.yml
129+
.yarn/install-state.gz
130+
.pnp.*
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"trailingComma": "es5",
3+
"tabWidth": 2,
4+
"semi": true,
5+
"singleQuote": true
6+
}

node/github-issue-bot/README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# 🤖 Node.js GitHub Issue Bot Function
2+
3+
Automate the process of responding to newly opened issues on a GitHub repository.
4+
5+
## 🧰 Usage
6+
7+
### `POST`
8+
9+
Handles webhook and returns a verification response.
10+
11+
**Parameters**
12+
13+
| Name | Description | Location | Type | Sample Value |
14+
| ------------------- | ------------------------- | -------- | ------ | ----------------------------------------------------------------------------------------------------- |
15+
| x-hub-signature-256 | GitHub webhook signature | Header | String | `h74ba0jbla01lagudfo` |
16+
| x-github-event | GitHub webhook event type | Header | String | `issues` |
17+
| JSON Body | GitHub webhook payload | Body | Object | See [GitHub docs](https://docs.github.com/en/webhooks-and-events/webhooks/webhook-events-and-payload) |
18+
19+
**Response**
20+
21+
Sample `200` Response:
22+
23+
Webhook verification successful.
24+
25+
```json
26+
{ "ok": true }
27+
```
28+
29+
Sample `401` Response:
30+
31+
Webhook verification failed.
32+
33+
```json
34+
{ "ok": false, "error": "Invalid signature" }
35+
```
36+
37+
## ⚙️ Configuration
38+
39+
| Setting | Value |
40+
| ----------------- | ------------- |
41+
| Runtime | Node (18.0) |
42+
| Entrypoint | `src/main.js` |
43+
| Build Commands | `npm install` |
44+
| Permissions | `any` |
45+
| Timeout (Seconds) | 15 |
46+
47+
## 🔒 Environment Variables
48+
49+
### GITHUB_WEBHOOK_SECRET
50+
51+
The secret used to verify that the webhook request comes from GitHub.
52+
53+
| Question | Answer |
54+
| ------------- | ----------------------------------------------------------------------------------------------- |
55+
| Required | Yes |
56+
| Sample Value | `d1efb...aec35` |
57+
| Documentation | [GitHub Docs](https://docs.github.com/en/developers/webhooks-and-events/securing-your-webhooks) |
58+
59+
### GITHUB_TOKEN
60+
61+
A personal access token from GitHub with the necessary permissions to post comments on issues.
62+
63+
| Question | Answer |
64+
| ------------- | ---------------------------------------------------------------------------------------------------------- |
65+
| Required | Yes |
66+
| Sample Value | `ghp_1...` |
67+
| Documentation | [GitHub Docs](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token) |

node/github-issue-bot/env.d.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
declare global {
2+
namespace NodeJS {
3+
interface ProcessEnv {
4+
GITHUB_TOKEN: string;
5+
GITHUB_WEBHOOK_SECRET: string;
6+
}
7+
}
8+
}
9+
10+
export {};

0 commit comments

Comments
 (0)