Skip to content

Commit

Permalink
fix(doc): design update
Browse files Browse the repository at this point in the history
  • Loading branch information
wyvern8 committed Nov 29, 2017
1 parent 17a2f78 commit ba55446
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,21 @@ Create an asynchronous CI agnostic mechanism for running custom test stage gates

## Design draft RFC

- Deploy two functions to lambda via serverless framework ('pending', 'results')
- github hooks pointed at 'pending' lambda which adds a 'job' to a 'pending' SQS queue
- ci host agent(s) watch SQS for new test execution jobs
- ci host adds results to a 'results' SQS queue, notifies SNS topic which triggers 'results' lambda
- results lambda posts results to github pull request.
- Deploy two functions to lambda via serverless framework ('gtmGithubHook', 'gtmGithubResults')
- github PR open hook pointed at 'gtmGithubHook' lambda which adds event to a 'PendingQueue' SQS queue
- agent(s) watch SQS for new test execution jobs
- agent notifies 'ResultsQueue' SQS queue that a task has started (lambda updates github PR state)
- agent triggers CI PR build, deploy and tests (plugin for each CI type)
- agent formats and adds test results to 'ResultsQueue' SQS queue
- agent notifies SNS topic which triggers 'gtmGithubResults' lambda
- 'gtmGithubResults' lambda posts results to github pull request.

<a href="https://github.com/wyvern8/github-task-manager">
<img src="https://raw.githubusercontent.com/wyvern8/github-task-manager/master/github-task-manager.png?raw=true" alt="" title="github-task-manager flow">
</a>

## Install
- clone this repo (TODO: or `npm install --save-dev serverless`)
- clone this repo (TODO: or `npm install --save-dev github-task-manager`)
- npm install
- setup serverless aws creds per https://github.com/serverless/serverless/blob/master/docs/providers/aws/guide/credentials.md
- setup a .env file in the repo root
Expand Down
Binary file added github-task-manager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ba55446

Please sign in to comment.