1 Commits

Author SHA1 Message Date
bf7159ec33 chore: add dotenv, ocktkat 2018-10-17 11:11:31 -07:00
19 changed files with 9 additions and 310 deletions

1
.gitignore vendored
View File

@@ -9,4 +9,3 @@ coverage
.nyc_output .nyc_output
coverage.lcov coverage.lcov
/lib /lib
/data

View File

@@ -1,3 +0,0 @@
### Authors
- joe fleming ([w33ble](https://github.com/w33ble))

View File

@@ -1,20 +0,0 @@
### Changelog
#### [v1.1.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.0.1...v1.1.0) (22 October 2018)
- feat: add timestamp to log output [`725638e`](https://git.w33ble.com/w33ble/gh-action-bot/commit/725638ee6b7fbb816518239f5524f6c37056da2e)
#### [v1.0.1](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.0.0...v1.0.1) (22 October 2018)
- feat: add a force retest script [`def91e3`](https://git.w33ble.com/w33ble/gh-action-bot/commit/def91e35d3c8028b7f78772049b0e93c3c8d677e)
- fix: add error handling code [`3b44968`](https://git.w33ble.com/w33ble/gh-action-bot/commit/3b4496864b0e9bd248e6d4ea12f2608dd41c0374)
- docs: add info about force script [`eb4666c`](https://git.w33ble.com/w33ble/gh-action-bot/commit/eb4666c3df312a9b5d8eb8ff5cf58027d794b417)
- docs: add token info to readme [`4794c6b`](https://git.w33ble.com/w33ble/gh-action-bot/commit/4794c6be2673402d5a76d8c61974ba3f9c936977)
### [v1.0.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v0.1.0...v1.0.0) (18 October 2018)
- feat: allow filtering by pr author [`68cccb7`](https://git.w33ble.com/w33ble/gh-action-bot/commit/68cccb72a9801c502003c7b913844fc01721a6e3)
#### v0.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)

View File

@@ -1,22 +1,11 @@
# gh-action-bot # gh-action-bot
Action bot for Github. Checks a repo's event stream and leaves a ghost comment when your criteria is met. Action bot for Github.
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
[![Project Status](https://img.shields.io/badge/status-stable-green.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index) [![npm](https://img.shields.io/npm/v/gh-action-bot.svg)](https://www.npmjs.com/package/gh-action-bot)
[![Project Status](https://img.shields.io/badge/status-experimental-orange.svg)](https://nodejs.org/api/documentation.html#documentation_stability_index)
## Usage
`yarn start owner/repo`: watch the event stream and handle matches
`yarn run force owner/repo pr_number`: force a comment on a specific pr, by number
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.
### Personal Access Token
You will need to provide a Github [Personal Access Token](https://github.com/settings/tokens/new). It will need `write:org` access in order to create comments.
#### License #### License
MIT © [w33ble](https://github.com/w33ble) MIT © [w33ble](https://github.com/w33ble)

View File

View File

@@ -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;
mod(); module.exports = mod;

View File

@@ -1,3 +1,3 @@
import mod from './src/index.mjs'; import mod from './src/index.mjs';
mod(); export default mod;

View File

@@ -1,7 +1,6 @@
{ {
"name": "gh-action-bot", "name": "gh-action-bot",
"version": "1.1.0", "version": "0.0.0",
"private": true,
"description": "Action bot for Github", "description": "Action bot for Github",
"main": "index", "main": "index",
"module": "index.mjs", "module": "index.mjs",
@@ -9,8 +8,7 @@
"lint": "eslint \"*.{js,mjs}\" \"src/**/*.{js,mjs}\"", "lint": "eslint \"*.{js,mjs}\" \"src/**/*.{js,mjs}\"",
"precommit": "lint-staged", "precommit": "lint-staged",
"version": "auto-changelog -p && auto-authors && git add CHANGELOG.md AUTHORS.md", "version": "auto-changelog -p && auto-authors && git add CHANGELOG.md AUTHORS.md",
"start": "node .", "start": "node ."
"force": "node -r esm src/force.mjs"
}, },
"repository": { "repository": {
"type": "git", "type": "git",

View File

@@ -1,7 +0,0 @@
GITHUB_ACCESS_TOKEN=xxx
COMMENT_ACTOR=username
COMMENT_BODY_REGEXP=build failed
COMMENT_BODY_REGEXP_FLAGS=i
PULL_LABEL_FILTER=
PULL_AUTHOR_FILTER=
PULL_RETEST_BODY=retest

View File

@@ -1,20 +0,0 @@
import dotenv from 'dotenv';
import createRepo from './lib/create_repo.mjs';
import { createComment, deleteComment } from './lib/comments.mjs';
dotenv.config();
async function forceRetest() {
const [ownerRepo, prNumber] = process.argv.splice(2);
const { PULL_RETEST_BODY } = process.env;
if (!ownerRepo || !prNumber) {
throw new Error('You must specify an owner/repo combo and a pull request number');
}
const repo = createRepo(ownerRepo);
const comment = await createComment(repo, prNumber, PULL_RETEST_BODY);
await deleteComment(repo, comment.id);
}
forceRetest().catch(err => console.error(err));

View File

@@ -1,76 +1,3 @@
import dotenv from 'dotenv';
import logger from './lib/logger.mjs';
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();
async function ghActionBot() {
// 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_AUTHOR_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_AUTHOR_FILTER && !pull.owner !== PULL_AUTHOR_FILTER) return false; // filter on owner
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);
logger.log(`Found ${records.length} outstanding failures`);
await Promise.all(
records.map(async record => {
logger.log(`Re-testing PR #${record.pull.number}`);
const comment = await createComment(repo, records[0].pull.number, PULL_RETEST_BODY);
await deleteComment(repo, comment.id);
})
);
}
export default function() { export default function() {
return ghActionBot().catch(err => { // es6 module code goes here
logger.error(err);
return process.exit(1);
});
} }

View File

@@ -1,7 +0,0 @@
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();
}

View File

@@ -1,21 +0,0 @@
/* 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);
}

View File

@@ -1,33 +0,0 @@
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);
}

View File

@@ -1,22 +0,0 @@
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;
}

View File

@@ -1,23 +0,0 @@
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);
}

View File

@@ -1,12 +0,0 @@
export default async function getPull(repo, id) {
const pull = await repo.pulls(id).fetch();
return {
id: pull.id,
url: pull.url,
number: pull.number,
owner: pull.user.login,
state: pull.state,
title: pull.title,
labels: pull.labels.map(label => label.name),
};
}

View File

@@ -1,30 +0,0 @@
import fs from 'fs';
import path from 'path';
export default class History {
constructor() {
this.filePath = path.resolve('data', 'history.json');
try {
const data = fs.readFileSync(this.filePath);
this.db = data.length === 0 ? [] : JSON.parse(data);
} catch (e) {
this.db = [];
}
}
get(id) {
return this.db.find(doc => parseInt(doc.id, 10) === parseInt(id, 10));
}
add(doc) {
// prevent duplicate entries
if (this.get(doc.id)) return;
// add doc to history, truncate as needed
this.db.push(doc);
if (this.db.length > 1000) this.db.splice(0, 1000);
// write the updated content to the file
fs.writeFileSync(this.filePath, JSON.stringify(this.db), { encoding: 'utf8' });
}
}

View File

@@ -1,16 +0,0 @@
/* eslint no-console: 0 */
const wrapMessage = msg => `${new Date()}: ${msg.join(' ')}`;
const logger = {
log(...args) {
console.log(wrapMessage(args));
},
warn(...args) {
console.warn(wrapMessage(args));
},
error(...args) {
console.error(wrapMessage(args));
},
};
export default logger;