You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
github-codebuild-integration is a CI dispatching/status handling tool to integrate AWS CodeBuild with GitHub Push/Pull-Request webhook events, created with love of Serverless Architecture.
9
+
`gci` is a CI dispatching/status handling tool to integrate AWS CodeBuild with GitHub Push/Pull-Request webhook events, created with love of Serverless Architecture.
10
10
11
11
## Overview
12
12
@@ -27,35 +27,35 @@ Yay, Serverless!
27
27
- Invoking a pre-configured AWS CodeBuild project by hooking Push or Pull Reqeust webhook events.
28
28
- Setting GitHub's CI status based on status/result of builds on AWS CodeBuild.
GitHub repository : AWS CodeBuild project | 1 : 1 (will be extended to 1 : n in the future)
39
39
40
-
As mentioned above, github-codebuild-integration can be installed as many as you want to integrate with your GitHub repositories. If you want to build 3 repositories, you may provision 3 of github-codebuild-integration installation for instance.
40
+
As mentioned above, gci can be installed as many as you want to integrate with your GitHub repositories. If you want to build 3 repositories, you may provision 3 of gci installation for instance.
41
41
42
42
## Background
43
43
44
44
GitHub has a feature to show each commit's status like 'success', 'failure', 'pending' on their Commit/PR pages, and based on that status, we can protect any branches from CI failed branch to be merged.
45
45
46
46
GitHub accepts status creation via their APIs and many third-party CI services implement functionalities to integrate with that APIs to show their job status on GitHub.
47
47
48
-
On the other hand, AWS CodeBuild doesn't have such a feature to save its build project status to GitHub for now. github-codebuild-integration is a missing piece of AWS CodeBuild to make things better.
48
+
On the other hand, AWS CodeBuild doesn't have such a feature to save its build project status to GitHub for now. gci is a missing piece of AWS CodeBuild to make things better.
49
49
50
50
## Requirements
51
51
52
52
### Prerequisites
53
53
54
-
github-codebuild-integration requires the following to be installed on your AWS account.
54
+
gci requires the following to be installed on your AWS account.
55
55
56
56
### Required Tools
57
57
58
-
We provide Makefile to you to manage github-codebuild-integration's lifecycle.
58
+
We provide Makefile to you to manage gci's lifecycle.
59
59
60
60
- GNU Make (if you are using macOS, `brew install make` is handy)
61
61
@@ -72,7 +72,7 @@ Provided commands use the following tools:
72
72
-`AdministratorAccess` to your AWS Account (to use AWS CloudFormation in the installation command)
73
73
- GitHub Account
74
74
75
-
And the listed resources below are created in the process of installation, which means they are required as available AWS services in a region where you want to run github-codebuild-integration.
75
+
And the listed resources below are created in the process of installation, which means they are required as available AWS services in a region where you want to run gci.
76
76
77
77
- Amazon S3
78
78
- Amazon SNS
@@ -85,20 +85,20 @@ And the listed resources below are created in the process of installation, which
85
85
## Installation
86
86
87
87
_**NOTE: Make sure the following before proceeding.**_
88
-
_**- You've loaded your [AWS credentials](http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html).**_
88
+
_**- You've loaded your [AWS credentials](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html).**_
89
89
_**- You've already created one AWS CodeBuild project at least.**_
90
90
91
91
### AWS Account-wide Resource
92
92
93
-
We have to create an S3 Bucket to store github-codebuild-integration's artifacts to provision it.
93
+
We have to create an S3 Bucket to store gci's artifacts to provision it.
_**NOTE: If you plan installing github-codebuild-integration into multiple AWS regions, you may create an S3 bucket for each AWS region.**_
101
+
_**NOTE: If you plan installing gci into multiple AWS regions, you may create an S3 bucket for each AWS region.**_
102
102
103
103
### Per-Project Resources
104
104
@@ -111,7 +111,7 @@ $ cd $(pwd)/github-codebuild-integration
111
111
112
112
#### Create GitHub Personal Access Token
113
113
114
-
Open [New personal access token](https://github.com/settings/tokens/new) page and create one for github-codebuild-integration's installation.
114
+
Open [New personal access token](https://github.com/settings/tokens/new) page and create one for gci's installation.
115
115
116
116
Input token description like `codebuild-YOUR_REPO_NAME` and enable `admin:repo_hook` and `repo:status` as scopes, then click the `Generate token` button.
Q: I changed my repository name after github-codebuild-integration install.
182
+
Q: I changed my repository name after gci install.
183
183
184
184
A: Change the value of `GITHUB_REPOSITORY_URL` in your env file, then deploy again.
185
185
@@ -200,7 +200,7 @@ A: I totally agree with you! It will be supported in the future. I think the fea
200
200
201
201
Q. Can you change the icon which shown at PR page's CI status?
202
202
203
-
A. GitHub shows the avatar of the user who owns the personal access token you provided. You can change the icon by using something like [Machine users](https://developer.github.com/v3/guides/managing-deploy-keys/#machine-users) to create a personal access token for github-codebuild-integration.
203
+
A. GitHub shows the avatar of the user who owns the personal access token you provided. You can change the icon by using something like [Machine users](https://developer.github.com/v3/guides/managing-deploy-keys/#machine-users) to create a personal access token for gci.
0 commit comments