Compare commits
5 Commits
d9fba56335
...
v0.1.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 87f4a94734 | |||
| a28d6a2509 | |||
| ced41f4a49 | |||
| c117cb847d | |||
| d1cfd7c20b |
3
AUTHORS.md
Normal file
3
AUTHORS.md
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
### Authors
|
||||||
|
|
||||||
|
- joe fleming ([w33ble](https://github.com/w33ble))
|
||||||
8
CHANGELOG.md
Normal file
8
CHANGELOG.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
### Changelog
|
||||||
|
|
||||||
|
#### 0.1.0 (18 October 2018)
|
||||||
|
- docs: update readme, add sample env [`a28d6a2`](https://git.w33ble.com/w33ble/gh-action-bot/commit/a28d6a25096efb9c8acea3e8d26e7f7f50dfd6b5)
|
||||||
|
- feat: add retest comment, delete it [`ced41f4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/ced41f4a495823205e5769e4531f923a982d29b4)
|
||||||
|
- feat: process 2 pages of events [`c117cb8`](https://git.w33ble.com/w33ble/gh-action-bot/commit/c117cb847d5cb7a6b57b705e0c192cc725c0d646)
|
||||||
|
- feat: fetch data for prs that need retest [`d1cfd7c`](https://git.w33ble.com/w33ble/gh-action-bot/commit/d1cfd7c20b17802f2de1b9153ae9a8392ed1bc44)
|
||||||
|
- feat: add history tracking [`b6b5c27`](https://git.w33ble.com/w33ble/gh-action-bot/commit/b6b5c27ffc43ff2e1c1ccf041958021cf7c8c4d4)
|
||||||
12
README.md
12
README.md
@@ -1,10 +1,16 @@
|
|||||||
# gh-action-bot
|
# gh-action-bot
|
||||||
|
|
||||||
Action bot for Github.
|
Action bot for Github. Checks a repo's event stream and leaves a ghost comment when your criteria is met.
|
||||||
|
|
||||||
[](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
|
[](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
|
||||||
[](https://www.npmjs.com/package/gh-action-bot)
|
[](https://nodejs.org/api/documentation.html#documentation_stability_index)
|
||||||
[](https://nodejs.org/api/documentation.html#documentation_stability_index)
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
`node . owner/repo`
|
||||||
|
|
||||||
|
You'll need to set some environment flags. Check `sample-env` for what is available, and you can copy the file to `.env` in the root and add your settings there as well.
|
||||||
|
|
||||||
|
|
||||||
#### License
|
#### License
|
||||||
|
|
||||||
|
|||||||
2
index.js
2
index.js
@@ -2,4 +2,4 @@
|
|||||||
require = require('esm')(module);
|
require = require('esm')(module);
|
||||||
const mod = require('./src/index.mjs').default;
|
const mod = require('./src/index.mjs').default;
|
||||||
|
|
||||||
module.exports = mod;
|
mod();
|
||||||
|
|||||||
@@ -1,3 +1,3 @@
|
|||||||
import mod from './src/index.mjs';
|
import mod from './src/index.mjs';
|
||||||
|
|
||||||
export default mod;
|
mod();
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "gh-action-bot",
|
"name": "gh-action-bot",
|
||||||
"version": "0.0.0",
|
"version": "0.1.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"description": "Action bot for Github",
|
"description": "Action bot for Github",
|
||||||
"main": "index",
|
"main": "index",
|
||||||
|
|||||||
6
sample-env
Normal file
6
sample-env
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
GITHUB_ACCESS_TOKEN=xxx
|
||||||
|
COMMENT_ACTOR=ci-comment-username
|
||||||
|
COMMENT_BODY_REGEXP=build failed
|
||||||
|
COMMENT_BODY_REGEXP_FLAGS=i
|
||||||
|
PULL_LABEL_FILTER=
|
||||||
|
PULL_RETEST_BODY=retest
|
||||||
@@ -1,3 +1,80 @@
|
|||||||
export default function() {
|
import dotenv from 'dotenv';
|
||||||
// es6 module code goes here
|
import createRepo from './lib/create_repo.mjs';
|
||||||
|
import getComments from './lib/get_comments.mjs';
|
||||||
|
import getPull from './lib/get_pull.mjs';
|
||||||
|
import getCommits from './lib/get_commits.mjs';
|
||||||
|
import getCommitStatus from './lib/get_commit_status.mjs';
|
||||||
|
import { createComment, deleteComment } from './lib/comments.mjs';
|
||||||
|
import History from './lib/history.mjs';
|
||||||
|
|
||||||
|
// load env vars from .env file
|
||||||
|
dotenv.config();
|
||||||
|
|
||||||
|
export default async function() {
|
||||||
|
// parse repo name from cli and create repo instance
|
||||||
|
const repo = createRepo(process.argv.splice(2)[0]);
|
||||||
|
const {
|
||||||
|
COMMENT_BODY_REGEXP,
|
||||||
|
COMMENT_BODY_REGEXP_FLAGS,
|
||||||
|
COMMENT_ACTOR,
|
||||||
|
PULL_LABEL_FILTER,
|
||||||
|
PULL_RETEST_BODY,
|
||||||
|
} = process.env;
|
||||||
|
|
||||||
|
// load the history module
|
||||||
|
const history = new History();
|
||||||
|
|
||||||
|
// fetch comment info from event stream, filter for only new comments
|
||||||
|
const comments = (await getComments(repo, {
|
||||||
|
body: new RegExp(COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS),
|
||||||
|
actor: COMMENT_ACTOR,
|
||||||
|
})).filter(comment => !history.get(comment.id));
|
||||||
|
|
||||||
|
// read pull data
|
||||||
|
const pulls = (await Promise.all(
|
||||||
|
comments.map(async comment => {
|
||||||
|
const pull = await getPull(repo, comment.number);
|
||||||
|
|
||||||
|
if (pull.state !== 'open') return false; // filter out any closed pulls
|
||||||
|
if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) return false; // filter on label
|
||||||
|
|
||||||
|
return { comment, pull };
|
||||||
|
})
|
||||||
|
)).filter(Boolean);
|
||||||
|
|
||||||
|
const records = (await Promise.all(
|
||||||
|
pulls.map(async ({ pull, comment }) => {
|
||||||
|
const commit = await getCommits(repo, pull.number, true);
|
||||||
|
const buildStatus = await getCommitStatus(repo, commit.sha);
|
||||||
|
// do nothing if the build has not started, or is pending or successful
|
||||||
|
if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success')
|
||||||
|
return false;
|
||||||
|
return { comment, pull, commit, buildStatus };
|
||||||
|
})
|
||||||
|
)).filter(Boolean);
|
||||||
|
|
||||||
|
console.log(`Found ${records.length} outstanding failures`);
|
||||||
|
|
||||||
|
await Promise.all(
|
||||||
|
records.map(async record => {
|
||||||
|
console.log(`Re-testing PR #${record.pull.number}`);
|
||||||
|
const comment = await createComment(repo, records[0].pull.number, PULL_RETEST_BODY);
|
||||||
|
await deleteComment(repo, comment.id);
|
||||||
|
})
|
||||||
|
);
|
||||||
|
|
||||||
|
/*
|
||||||
|
|
||||||
|
TODO:
|
||||||
|
|
||||||
|
- [x] keep track of seen comment ids, only process new ones
|
||||||
|
- [x] check the pr's status and only retest if no longer "Pending"
|
||||||
|
- [x] add a retest comment
|
||||||
|
- POST /repos/:owner/:repo/issues/:number/comments
|
||||||
|
- [x] delete the retest comment
|
||||||
|
- [ ] delete the build comment
|
||||||
|
- [ ] delete ALL build failure comments
|
||||||
|
- DELETE /repos/:owner/:repo/issues/comments/:comment_id
|
||||||
|
|
||||||
|
*/
|
||||||
}
|
}
|
||||||
|
|||||||
7
src/lib/comments.mjs
Normal file
7
src/lib/comments.mjs
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
export async function createComment(repo, issueId, body) {
|
||||||
|
return repo.issues(issueId).comments.create({ body });
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function deleteComment(repo, commentId) {
|
||||||
|
return repo.issues.comments(commentId).remove();
|
||||||
|
}
|
||||||
21
src/lib/create_repo.mjs
Normal file
21
src/lib/create_repo.mjs
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
/* eslint no-console: 0 */
|
||||||
|
import Octokat from 'octokat';
|
||||||
|
|
||||||
|
function usageError() {
|
||||||
|
console.error('You must provide a github repo in the form of "owner/repo"');
|
||||||
|
process.exit(1);
|
||||||
|
}
|
||||||
|
|
||||||
|
export default function(repo) {
|
||||||
|
if (typeof repo !== 'string' || repo.length === 0) usageError();
|
||||||
|
const settings = {
|
||||||
|
token: process.env.GITHUB_ACCESS_TOKEN,
|
||||||
|
};
|
||||||
|
|
||||||
|
const octo = new Octokat(settings);
|
||||||
|
const [owner, name] = repo.split('/');
|
||||||
|
|
||||||
|
if (!owner || !name) usageError();
|
||||||
|
|
||||||
|
return octo.repos(owner, name);
|
||||||
|
}
|
||||||
33
src/lib/get_comments.mjs
Normal file
33
src/lib/get_comments.mjs
Normal file
@@ -0,0 +1,33 @@
|
|||||||
|
export default async function getEvents(repo, { body, actor } = {}) {
|
||||||
|
const events = await repo.events.fetch();
|
||||||
|
|
||||||
|
const items = await (async () => {
|
||||||
|
// process 2 pages of events
|
||||||
|
if (events.nextPage) {
|
||||||
|
const moreEvents = await events.nextPage.fetch();
|
||||||
|
return [...events.items, ...moreEvents.items];
|
||||||
|
}
|
||||||
|
|
||||||
|
return events.items;
|
||||||
|
})();
|
||||||
|
|
||||||
|
return items
|
||||||
|
.map(comment => {
|
||||||
|
// only comments created by specific user
|
||||||
|
if (comment.type !== 'IssueCommentEvent') return false;
|
||||||
|
if (comment.payload.action !== 'created') return false;
|
||||||
|
if (comment.actor.login !== actor) return false;
|
||||||
|
if (body && !body.test(comment.payload.comment.body)) return false;
|
||||||
|
|
||||||
|
return {
|
||||||
|
id: comment.id,
|
||||||
|
number: comment.payload.issue.number,
|
||||||
|
owner: comment.payload.issue.user.login,
|
||||||
|
labels: comment.payload.issue.labels.map(label => label.name),
|
||||||
|
comment_id: comment.payload.comment.id,
|
||||||
|
comment_author: comment.payload.comment.user.login,
|
||||||
|
comment_body: comment.payload.comment.body,
|
||||||
|
};
|
||||||
|
})
|
||||||
|
.filter(Boolean);
|
||||||
|
}
|
||||||
22
src/lib/get_commit_status.mjs
Normal file
22
src/lib/get_commit_status.mjs
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
function getBuildStatus({ items: statuses }) {
|
||||||
|
const buildStatus = statuses.find(status => status.context === 'kibana-ci');
|
||||||
|
if (!buildStatus) return buildStatus;
|
||||||
|
return {
|
||||||
|
id: buildStatus.id,
|
||||||
|
url: buildStatus.url,
|
||||||
|
state: buildStatus.state,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export default async function getCommitStatus(repo, sha) {
|
||||||
|
const statuses = await repo.commits(sha).statuses.fetch();
|
||||||
|
|
||||||
|
const buildStatus = await (async stats => {
|
||||||
|
if (stats.lastPage) {
|
||||||
|
return getBuildStatus(await stats.lastPage.fetch());
|
||||||
|
}
|
||||||
|
return getBuildStatus(stats);
|
||||||
|
})(statuses);
|
||||||
|
|
||||||
|
return buildStatus;
|
||||||
|
}
|
||||||
23
src/lib/get_commits.mjs
Normal file
23
src/lib/get_commits.mjs
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
function formatCommit(commit) {
|
||||||
|
return {
|
||||||
|
sha: commit.sha,
|
||||||
|
owner: commit.committer.login,
|
||||||
|
message: commit.commit.message,
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatCommits(commits, lastOnly) {
|
||||||
|
if (lastOnly) return formatCommit(commits.pop());
|
||||||
|
return commits.map(c => formatCommit(c));
|
||||||
|
}
|
||||||
|
|
||||||
|
export default async function getCommits(repo, id, lastOnly = true) {
|
||||||
|
const commits = await repo.pulls(id).commits.fetch();
|
||||||
|
|
||||||
|
if (commits.lastPage) {
|
||||||
|
const { items } = await commits.lastPage.fetch();
|
||||||
|
return formatCommits(items, lastOnly);
|
||||||
|
}
|
||||||
|
|
||||||
|
return formatCommits(commits.items, lastOnly);
|
||||||
|
}
|
||||||
11
src/lib/get_pull.mjs
Normal file
11
src/lib/get_pull.mjs
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
export default async function getPull(repo, id) {
|
||||||
|
const pull = await repo.pulls(id).fetch();
|
||||||
|
return {
|
||||||
|
id: pull.id,
|
||||||
|
url: pull.url,
|
||||||
|
number: pull.number,
|
||||||
|
state: pull.state,
|
||||||
|
title: pull.title,
|
||||||
|
labels: pull.labels.map(label => label.name),
|
||||||
|
};
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user