Compare commits
1 Commits
v1.2.1
...
ec14a479c8
| Author | SHA1 | Date | |
|---|---|---|---|
| ec14a479c8 |
@@ -1,3 +0,0 @@
|
|||||||
### Authors
|
|
||||||
|
|
||||||
- joe fleming ([w33ble](https://github.com/w33ble))
|
|
||||||
30
CHANGELOG.md
30
CHANGELOG.md
@@ -1,30 +0,0 @@
|
|||||||
### Changelog
|
|
||||||
|
|
||||||
#### [v1.2.1](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.2.0...v1.2.1) (23 October 2018)
|
|
||||||
- feat: add more debugging output [`3db973f`](https://git.w33ble.com/w33ble/gh-action-bot/commit/3db973febc5387605279f7855976a4ec431f0362)
|
|
||||||
- fix: correctly handle errors in logger.error [`c70e8e4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/c70e8e49ecb9041b22a8f4b92398339d45871ca1)
|
|
||||||
- fix: correctly check for pr author [`f4c3e02`](https://git.w33ble.com/w33ble/gh-action-bot/commit/f4c3e02c1a31aea89a565f5685dd3b879bd38b14)
|
|
||||||
|
|
||||||
#### [v1.2.0](https://git.w33ble.com/w33ble/gh-action-bot/compare/v1.1.0...v1.2.0) (23 October 2018)
|
|
||||||
- feat: add debugging output to script [`0dce327`](https://git.w33ble.com/w33ble/gh-action-bot/commit/0dce32781b0f8c138d7f8b28382289d67be730dd)
|
|
||||||
- feat: debug logging and better timestamps [`08799b4`](https://git.w33ble.com/w33ble/gh-action-bot/commit/08799b48d74d12266d5ebb85811f5d3fa046b086)
|
|
||||||
- docs: add note about using DEBUG=1 output [`872d9c7`](https://git.w33ble.com/w33ble/gh-action-bot/commit/872d9c790fc723f1b255536225be60f547cf5196)
|
|
||||||
|
|
||||||
#### [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)
|
|
||||||
21
README.md
21
README.md
@@ -1,25 +1,10 @@
|
|||||||
# 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.
|
||||||
|
|
||||||
[](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
|
[](https://raw.githubusercontent.com/w33ble/gh-action-bot/master/LICENSE)
|
||||||
[](https://nodejs.org/api/documentation.html#documentation_stability_index)
|
[](https://www.npmjs.com/package/gh-action-bot)
|
||||||
|
[](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.
|
|
||||||
|
|
||||||
### Debugging
|
|
||||||
|
|
||||||
If the script isn't doing what you expect, you can get more output from it by prepending the script with `DEBUG=1`.
|
|
||||||
|
|
||||||
#### License
|
#### License
|
||||||
|
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "gh-action-bot",
|
"name": "gh-action-bot",
|
||||||
"version": "1.2.1",
|
"version": "0.0.0",
|
||||||
"private": true,
|
"private": true,
|
||||||
"description": "Action bot for Github",
|
"description": "Action bot for Github",
|
||||||
"main": "index",
|
"main": "index",
|
||||||
@@ -9,8 +9,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",
|
||||||
|
|||||||
@@ -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
|
|
||||||
@@ -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));
|
|
||||||
@@ -1,28 +1,17 @@
|
|||||||
import dotenv from 'dotenv';
|
import dotenv from 'dotenv';
|
||||||
import logger from './lib/logger.mjs';
|
|
||||||
import createRepo from './lib/create_repo.mjs';
|
import createRepo from './lib/create_repo.mjs';
|
||||||
import getComments from './lib/get_comments.mjs';
|
import getComments from './lib/get_comments.mjs';
|
||||||
import getPull from './lib/get_pull.mjs';
|
import getPull from './lib/get_pull.mjs';
|
||||||
import getCommits from './lib/get_commits.mjs';
|
import getCommits from './lib/get_commits.mjs';
|
||||||
import getCommitStatus from './lib/get_commit_status.mjs';
|
import getCommitStatus from './lib/get_commit_status.mjs';
|
||||||
import { createComment, deleteComment } from './lib/comments.mjs';
|
|
||||||
import History from './lib/history.mjs';
|
import History from './lib/history.mjs';
|
||||||
|
|
||||||
// load env vars from .env file
|
|
||||||
dotenv.config();
|
dotenv.config();
|
||||||
|
|
||||||
async function ghActionBot() {
|
export default async function() {
|
||||||
// parse repo name from cli and create repo instance
|
// parse repo name from cli and create repo instance
|
||||||
const repo = createRepo(process.argv.splice(2)[0]);
|
const repo = createRepo(process.argv.splice(2)[0]);
|
||||||
|
const { COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS, COMMENT_ACTOR } = process.env;
|
||||||
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
|
// load the history module
|
||||||
const history = new History();
|
const history = new History();
|
||||||
@@ -33,24 +22,11 @@ async function ghActionBot() {
|
|||||||
actor: COMMENT_ACTOR,
|
actor: COMMENT_ACTOR,
|
||||||
})).filter(comment => !history.get(comment.id));
|
})).filter(comment => !history.get(comment.id));
|
||||||
|
|
||||||
// read pull data
|
// read pull data, filter out any closed pulls
|
||||||
const pulls = (await Promise.all(
|
const pulls = (await Promise.all(
|
||||||
comments.map(async comment => {
|
comments.map(async comment => {
|
||||||
const pull = await getPull(repo, comment.number);
|
const pull = await getPull(repo, comment.number);
|
||||||
|
if (pull.state !== 'open') return false;
|
||||||
if (pull.state !== 'open') {
|
|
||||||
logger.debug(`SKIP #${pull.number}: state is ${pull.state}`);
|
|
||||||
return false; // filter out any closed pulls
|
|
||||||
}
|
|
||||||
if (PULL_AUTHOR_FILTER && pull.owner !== PULL_AUTHOR_FILTER) {
|
|
||||||
logger.debug(`SKIP #${pull.number}: author is ${pull.owner}`);
|
|
||||||
return false; // filter on owner
|
|
||||||
}
|
|
||||||
if (PULL_LABEL_FILTER && !pull.labels.includes(PULL_LABEL_FILTER)) {
|
|
||||||
logger.debug(`SKIP #${pull.number}: labels are ${pull.labels.join(',')}`);
|
|
||||||
return false; // filter on label
|
|
||||||
}
|
|
||||||
|
|
||||||
return { comment, pull };
|
return { comment, pull };
|
||||||
})
|
})
|
||||||
)).filter(Boolean);
|
)).filter(Boolean);
|
||||||
@@ -60,33 +36,27 @@ async function ghActionBot() {
|
|||||||
const commit = await getCommits(repo, pull.number, true);
|
const commit = await getCommits(repo, pull.number, true);
|
||||||
const buildStatus = await getCommitStatus(repo, commit.sha);
|
const buildStatus = await getCommitStatus(repo, commit.sha);
|
||||||
// do nothing if the build has not started, or is pending or successful
|
// do nothing if the build has not started, or is pending or successful
|
||||||
if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success') {
|
if (!buildStatus || buildStatus.state === 'pending' || buildStatus.state === 'success')
|
||||||
logger.debug(`SKIP #${pull.number}: build status is ${buildStatus.state}`);
|
|
||||||
return false;
|
return false;
|
||||||
}
|
|
||||||
return { comment, pull, commit, buildStatus };
|
return { comment, pull, commit, buildStatus };
|
||||||
})
|
})
|
||||||
)).filter(Boolean);
|
)).filter(Boolean);
|
||||||
|
|
||||||
if (records.length) {
|
console.log(records);
|
||||||
logger.log(`Found ${records.length} outstanding failures`);
|
process.exit();
|
||||||
} else {
|
|
||||||
logger.debug(`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);
|
|
||||||
logger.debug(`Created comment id ${comment.id}`);
|
|
||||||
await deleteComment(repo, comment.id);
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function() {
|
TODO:
|
||||||
return ghActionBot().catch(err => {
|
|
||||||
logger.error(err);
|
- [x] keep track of seen comment ids, only process new ones
|
||||||
return process.exit(1);
|
- [x] check the pr's status and only retest if no longer "Pending"
|
||||||
});
|
- [ ] add a retest comment
|
||||||
|
- POST /repos/:owner/:repo/issues/:number/comments
|
||||||
|
- [ ] delete the build comment
|
||||||
|
- DELETE /repos/:owner/:repo/issues/comments/:comment_id
|
||||||
|
- [ ] delete ALL build failure comments
|
||||||
|
- [ ] delete the retest comment
|
||||||
|
|
||||||
|
*/
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -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();
|
|
||||||
}
|
|
||||||
@@ -1,44 +1,13 @@
|
|||||||
import logger from './logger.mjs';
|
|
||||||
|
|
||||||
export default async function getEvents(repo, { body, actor } = {}) {
|
export default async function getEvents(repo, { body, actor } = {}) {
|
||||||
const events = await repo.events.fetch();
|
const { items: events } = await repo.events.fetch();
|
||||||
|
|
||||||
const items = await (async () => {
|
return events
|
||||||
// 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 => {
|
.map(comment => {
|
||||||
let skip = false;
|
// only comments created by specific user
|
||||||
const isComment = comment.type === 'IssueCommentEvent';
|
if (comment.type !== 'IssueCommentEvent') return false;
|
||||||
const bodyMatch = isComment && (!body || body.test(comment.payload.comment.body));
|
if (comment.payload.action !== 'created') return false;
|
||||||
const isActor = comment.actor.login === actor;
|
if (comment.actor.login !== actor) return false;
|
||||||
|
if (body && !body.test(comment.payload.comment.body)) return false;
|
||||||
// skip events that don't match the criteria
|
|
||||||
if (!isComment) skip = true;
|
|
||||||
if (comment.payload.action !== 'created') skip = true;
|
|
||||||
if (!isActor) skip = true;
|
|
||||||
if (isComment && !bodyMatch) skip = true;
|
|
||||||
|
|
||||||
if (skip) {
|
|
||||||
if (isActor) {
|
|
||||||
logger.debug(
|
|
||||||
`SKIP EVENT ${isComment ? `#${comment.payload.issue.number}` : comment.id}: ${
|
|
||||||
comment.type
|
|
||||||
} ${comment.payload.action} by ${comment.actor.login}`,
|
|
||||||
isComment && !bodyMatch && `(${comment.payload.comment.body.slice(0, 30)})`
|
|
||||||
);
|
|
||||||
}
|
|
||||||
return false;
|
|
||||||
}
|
|
||||||
|
|
||||||
logger.debug(`PROCESS #${comment.payload.issue.number}`);
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
id: comment.id,
|
id: comment.id,
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ export default async function getPull(repo, id) {
|
|||||||
id: pull.id,
|
id: pull.id,
|
||||||
url: pull.url,
|
url: pull.url,
|
||||||
number: pull.number,
|
number: pull.number,
|
||||||
owner: pull.user.login,
|
|
||||||
state: pull.state,
|
state: pull.state,
|
||||||
title: pull.title,
|
title: pull.title,
|
||||||
labels: pull.labels.map(label => label.name),
|
labels: pull.labels.map(label => label.name),
|
||||||
|
|||||||
@@ -1,43 +0,0 @@
|
|||||||
/* eslint no-console: 0 */
|
|
||||||
const zeroPad = (str, len) => {
|
|
||||||
let output = `${str}`;
|
|
||||||
if (!len || len <= output.length) return str;
|
|
||||||
|
|
||||||
while (output.length < len) {
|
|
||||||
output = `0${output}`;
|
|
||||||
}
|
|
||||||
return output;
|
|
||||||
};
|
|
||||||
|
|
||||||
const getTimestamp = () => {
|
|
||||||
const d = new Date();
|
|
||||||
return `${[d.getFullYear(), zeroPad(d.getMonth(), 2), zeroPad(d.getDate(), 2)].join('/')} ${[
|
|
||||||
zeroPad(d.getHours(), 2),
|
|
||||||
zeroPad(d.getMinutes(), 2),
|
|
||||||
zeroPad(d.getSeconds(), 2),
|
|
||||||
].join(':')}`;
|
|
||||||
};
|
|
||||||
|
|
||||||
const wrapMessage = msg => `[${getTimestamp()}]: ${msg.join(' ')}`;
|
|
||||||
|
|
||||||
const logger = {
|
|
||||||
log(...args) {
|
|
||||||
console.log(wrapMessage(args));
|
|
||||||
},
|
|
||||||
warn(...args) {
|
|
||||||
console.warn(wrapMessage(args));
|
|
||||||
},
|
|
||||||
error(...args) {
|
|
||||||
if (args[0] instanceof Error) {
|
|
||||||
console.error(getTimestamp(), args[0].stack);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
console.error(wrapMessage(args));
|
|
||||||
},
|
|
||||||
debug(...args) {
|
|
||||||
if (!process.env.DEBUG) return;
|
|
||||||
console.log(wrapMessage(args));
|
|
||||||
},
|
|
||||||
};
|
|
||||||
|
|
||||||
export default logger;
|
|
||||||
Reference in New Issue
Block a user