Compare commits
4 Commits
v1.0.1
...
ec6edf598c
| Author | SHA1 | Date | |
|---|---|---|---|
| ec6edf598c | |||
| cc7c5968cb | |||
| 5a1d666dae | |||
| bf7159ec33 |
@@ -1,3 +0,0 @@
|
|||||||
### Authors
|
|
||||||
|
|
||||||
- joe fleming ([w33ble](https://github.com/w33ble))
|
|
||||||
17
CHANGELOG.md
17
CHANGELOG.md
@@ -1,17 +0,0 @@
|
|||||||
### Changelog
|
|
||||||
|
|
||||||
#### [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)
|
|
||||||
17
README.md
17
README.md
@@ -1,21 +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.
|
|
||||||
|
|
||||||
#### License
|
#### License
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "gh-action-bot",
|
"name": "gh-action-bot",
|
||||||
"version": "1.0.1",
|
"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",
|
||||||
|
|||||||
@@ -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,45 +1,28 @@
|
|||||||
import dotenv from 'dotenv';
|
|
||||||
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
|
export default async function() {
|
||||||
dotenv.config();
|
|
||||||
|
|
||||||
async function ghActionBot() {
|
|
||||||
// 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,
|
|
||||||
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();
|
||||||
|
|
||||||
// fetch comment info from event stream, filter for only new comments
|
// fetch comment info from event stream, filter for only new comments
|
||||||
const comments = (await getComments(repo, {
|
const comments = (await getComments(repo, {
|
||||||
body: new RegExp(COMMENT_BODY_REGEXP, COMMENT_BODY_REGEXP_FLAGS),
|
body: /build failed/i,
|
||||||
actor: COMMENT_ACTOR,
|
actor: 'elasticmachine',
|
||||||
})).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') 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 };
|
return { comment, pull };
|
||||||
})
|
})
|
||||||
)).filter(Boolean);
|
)).filter(Boolean);
|
||||||
@@ -55,20 +38,21 @@ async function ghActionBot() {
|
|||||||
})
|
})
|
||||||
)).filter(Boolean);
|
)).filter(Boolean);
|
||||||
|
|
||||||
console.log(`Found ${records.length} outstanding failures`);
|
console.log(records);
|
||||||
|
process.exit();
|
||||||
|
|
||||||
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);
|
|
||||||
})
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
export default function() {
|
TODO:
|
||||||
return ghActionBot().catch(err => {
|
|
||||||
console.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();
|
|
||||||
}
|
|
||||||
@@ -8,11 +8,8 @@ function usageError() {
|
|||||||
|
|
||||||
export default function(repo) {
|
export default function(repo) {
|
||||||
if (typeof repo !== 'string' || repo.length === 0) usageError();
|
if (typeof repo !== 'string' || repo.length === 0) usageError();
|
||||||
const settings = {
|
|
||||||
token: process.env.GITHUB_ACCESS_TOKEN,
|
|
||||||
};
|
|
||||||
|
|
||||||
const octo = new Octokat(settings);
|
const octo = new Octokat();
|
||||||
const [owner, name] = repo.split('/');
|
const [owner, name] = repo.split('/');
|
||||||
|
|
||||||
if (!owner || !name) usageError();
|
if (!owner || !name) usageError();
|
||||||
|
|||||||
@@ -1,17 +1,7 @@
|
|||||||
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 => {
|
||||||
// only comments created by specific user
|
// only comments created by specific user
|
||||||
if (comment.type !== 'IssueCommentEvent') return false;
|
if (comment.type !== 'IssueCommentEvent') return false;
|
||||||
|
|||||||
@@ -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),
|
||||||
|
|||||||
Reference in New Issue
Block a user