Skip to content

Commit e38a5b2

Browse files
committed
Merge branch 'gci'
* gci: README: Use "gci" as an alias for the tool name README: Replace http links to https
2 parents 1ee7ea1 + 5bf6e70 commit e38a5b2

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

README.md

+21-21
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# github-codebuild-integration
1+
# github-codebuild-integration (gci)
22

3-
[![GitHub release](http://img.shields.io/github/release/toricls/github-codebuild-integration.svg?style=flat-square)][release]
4-
[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
3+
[![GitHub release](https://img.shields.io/github/release/toricls/github-codebuild-integration.svg?style=flat-square)][release]
4+
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)][license]
55

66
[release]: https://github.com/toricls/github-codebuild-integration/releases
77
[license]: https://github.com/toricls/github-codebuild-integration/blob/master/LICENSE
88

9-
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.
1010

1111
## Overview
1212

@@ -27,35 +27,35 @@ Yay, Serverless!
2727
- Invoking a pre-configured AWS CodeBuild project by hooking Push or Pull Reqeust webhook events.
2828
- Setting GitHub's CI status based on status/result of builds on AWS CodeBuild.
2929

30-
### AWS account / github-codebuild-integration / GitHub repository
30+
### AWS account / gci / GitHub repository
3131

32-
github-codebuild-integration allows you to provision multiple installations in one AWS account as follows:
32+
gci allows you to provision multiple installations in one AWS account as follows:
3333

3434
Resources | Relation
3535
---------- | ----------
36-
AWS account : github-codebuild-integration installations | 1 : n
37-
github-codebuild-integration installation : GitHub repository | 1 : 1
36+
AWS account : gci installations | 1 : n
37+
gci installation : GitHub repository | 1 : 1
3838
GitHub repository : AWS CodeBuild project | 1 : 1 (will be extended to 1 : n in the future)
3939

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.
4141

4242
## Background
4343

4444
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.
4545

4646
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.
4747

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.
4949

5050
## Requirements
5151

5252
### Prerequisites
5353

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.
5555

5656
### Required Tools
5757

58-
We provide Makefile to you to manage github-codebuild-integration's lifecycle.
58+
We provide Makefile to you to manage gci's lifecycle.
5959

6060
- GNU Make (if you are using macOS, `brew install make` is handy)
6161

@@ -72,7 +72,7 @@ Provided commands use the following tools:
7272
- `AdministratorAccess` to your AWS Account (to use AWS CloudFormation in the installation command)
7373
- GitHub Account
7474

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.
7676

7777
- Amazon S3
7878
- Amazon SNS
@@ -85,20 +85,20 @@ And the listed resources below are created in the process of installation, which
8585
## Installation
8686

8787
_**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).**_
8989
_**- You've already created one AWS CodeBuild project at least.**_
9090

9191
### AWS Account-wide Resource
9292

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.
9494

9595
```
9696
$ aws s3api create-bucket \
9797
--bucket {YOUR_S3_BUCKET_NAME} \
9898
--create-bucket-configuration LocationConstraint=$AWS_DEFAULT_REGION
9999
```
100100

101-
_**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.**_
102102

103103
### Per-Project Resources
104104

@@ -111,7 +111,7 @@ $ cd $(pwd)/github-codebuild-integration
111111

112112
#### Create GitHub Personal Access Token
113113

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.
115115

116116
Input token description like `codebuild-YOUR_REPO_NAME` and enable `admin:repo_hook` and `repo:status` as scopes, then click the `Generate token` button.
117117

@@ -127,7 +127,7 @@ $ cp env/example.env env/$YOUR_PROJECT_NAME.env
127127
$ editor env/$YOUR_PROJECT_NAME.env
128128
```
129129

130-
Next table describes about all available parameters of github-codebuild-integration.
130+
Next table describes about all available parameters of gci.
131131

132132
Required | Parameter Name | What is this | Example
133133
------------ | ------------ | ------------- | -------------
@@ -171,15 +171,15 @@ A. Ask your administrator and show him/her the following:
171171

172172
[required-accounts--resources]: https://github.com/toricls/github-codebuild-integration/blob/master/README.md#required-accounts--resources
173173

174-
Q: I want to remove all resources of github-codebuild-integration from my AWS account.
174+
Q: I want to remove all resources of gci from my AWS account.
175175

176176
A: Read the [Uninstall][uninstall] section above :X
177177

178178
[uninstall]: https://github.com/toricls/github-codebuild-integration/blob/master/README.md#uninstall
179179

180180
### Changing Configurations
181181

182-
Q: I changed my repository name after github-codebuild-integration install.
182+
Q: I changed my repository name after gci install.
183183

184184
A: Change the value of `GITHUB_REPOSITORY_URL` in your env file, then deploy again.
185185

@@ -200,7 +200,7 @@ A: I totally agree with you! It will be supported in the future. I think the fea
200200

201201
Q. Can you change the icon which shown at PR page's CI status?
202202

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.
204204

205205
## Contribution
206206

0 commit comments

Comments
 (0)