CircleCI User Community Fukuoka #1

## OSSで活用するCircle Ci 【福岡】CircleCI ユーザーコミュニティミートアップ #1 清家史郎(@seike460)

###### Who? Fusic Co., Ltd.  清家史郎  @seike460 [](https://twitter.com/seike460) [](https://www.facebook.com/seike460) [](https://github.com/seike460)

### tech - Program Language - PHP - Go - infrastructure - Server, Network - IaC - Cloud - AWS SA Professional - Other - Serverless - Vue.js、React

- CircleCI - 完全に理解した  <!-- .element: class="fragment" -->

### OSS products - AWS Tools (Go) - [FictionBase](https://github.com/fictionbase/fictionbase) - Serverless Runtimel Base - [s3ry](https://github.com/seike460/s3ry) - S3 prompt cli - [utakata](https://github.com/seike460/utakata) - Serverless Slack Ical Notificator

このスライドは公開済みです https://slide.seike460.com/slides/circlecijp_fukuoka_1#/

# 15秒告知

### Serverless Meetup Fukuoka #5 - 6〜7月を予定 - 登壇者募集！！！

### PHPカンファレンス福岡2019 `#phpconfuk` - 2019.6.29(sat) 10:00 - 18:00 

### Go Conference '19 Summer in Fukuoka - 2019.7.13(sat) 10:00 - 19:00 <img src='https://fukuoka.gocon.jp/_nuxt/img/f11c90f.webp' width='300px'> スポンサー募集中!!!!

#### Agenda - OSSでCircleCIを利用する理由 <!-- .element: class="fragment" --> - OSSのCircleCI設定 <!-- .element: class="fragment" --> - CircleCI基本設定 <!-- .element: class="fragment" --> - Badge設定 <!-- .element: class="fragment" --> - まとめ <!-- .element: class="fragment" -->

## OSSでCircleCIを利用する理由

### CircleCIをOSSで利用する ``` オープンソースプロジェクトのユーザーは、合計で 4 つの Linux コンテナ (年間総額 $2400 相当) を無料でご利用いただけます。 プロジェクトを一般に公開するだけで、どんなプロジェクトでもこの特典をご利用いただけます。 ``` OSSを利用する上で実質無料 (超人気プロダクトに成長した場合は話は別) -> 使わない手はない

### 何故OSSで品質を上げたいのか - OSSを公開するモチベーション - 使ってもらいたい - 使ってもらう為には - 魅力的な機能 - READMEの充実 - `安定した品質` CIで`安定した品質`のOSSで有ることを証明する事で利用者の増加が見込める

### OSSにおいて安定した品質を証明する為には ソフトウェアテストを実行し、品質を証明する

### ソフトウェアテストの正当性を証明する指標 - テストが正常に完了しているか - テストのカバレッジ 完全では無いが指標として提示出来る ※あくまで開発者の認識範囲内でのテスト実行に関する結果であることに注意

### 正当性の指標を利用者に提示したい - ソフトウェアテストを書いた - カバレッジ率も取得した - 利用者に伝えたい #### Badge表示 -> CircleCIを利用

### 具体的なCircleCI設定 #### Githubにおける設定

### 初期設定 #### テストを書く - PHP - PHPUnit - Go - 標準のテストpackage ``` go test -v -race -cover -coverprofile=coverage.out ./... ``` 清家は複数パッケージをまとめてカバレッジする為のgoverageを利用 [haya14busa/goverage](https://github.com/haya14busa/goverage)

Organization選択 

ADD PROJECT 

config.yml設定 利用言語を選択しsample設定を`Copy To Clipboard`でコピー 自分のGithubリポジトリに`.circleci/config.yml`をコピーした内容で作成  [config.yml](https://github.com/fictionbase/monitor/blob/master/.circleci/config.yml)

### Slack通知設定 Slack用のWEB Hook URLを入力して実行 - OverrideRoom - WebhookURL以外のチャンネルに通知可能 - Fixed/Faild - 通知するタイミングを制限

- 設定画面 

- 通知の様子 

ここまでで基本設定は完了 続いてOSS向けの設定 ### Badge設定 <!-- .element: class="fragment" -->

### Badge - Build Status Badge - ソフトウェアテストが成功しているかを表す - Release Badge - 現在のReleaseバージョンを表す - coverage Badge - ソフトウェアテストのカバレッジを表す これらのBadgeをREADMEに表示します

### Build Status Badge まずはCircleCIにてテストを通します

Status Badgeを表示したいリポジトリの歯車マークを選択 

statusBadgeのサイドバーを選択して、README用のMarkDownをコピー 

### Release Badge img.shields.ioを利用 `https://img.shields.io/github/release/【Organizations】/【Repository】.svg` fictionbase/fictionbaseのRelease状況を表示するには以下 https://img.shields.io/github/release/fictionbase/fictionbase.svg - Release有り -  - Release無し - 

### coverage Badge - Codecov - コードのカバレッジを計測を可視化 - slackに通知 - Githubに通知

### codecov基本設定 基本的に下記を参照すればOK [Generating Code Coverage Metrics](Generating Code Coverage Metrics)

- 対象リポジトリ token発行 

- token Copy 

- CircleCI Environment Variablesに token設定 

`.codecov.yml`を配置 https://github.com/fictionbase/fictionbase/blob/master/.codecov.yml

`.circleci/config.yml`にcodecovへのデータ送信用のコマンドを設定する https://github.com/fictionbase/fictionbase/blob/master/.circleci/config.yml#L31

CircleCIにてBuild データが連携されるのを確認する 

### [orbs設定](https://circleci.com/orbs/registry/orb/codecov/codecov) CircleCI の commands や jobs, executors を パッケージとして使い回すことのできる仕組みでver 2.1から利用可能 `.circleci/config.yml`を以下の様に変更 version 2.1に変更 ``` version: 2.1 ``` orbsを利用する宣言 ``` orbs: codecov: codecov/codecov@1.0.4 ``` データのアップロードコマンド追加 ``` - codecov/upload: - file: ./coverage.out ```

READMEの内容にコピーすると実際のREADMEに表示される https://github.com/fictionbase/fictionbase/blob/master/README.md 

### 雰囲気の比較 - Badge無し - https://github.com/fictionbase/endpoint - Badge有り、テスト不十分 - https://github.com/fictionbase/fictionbase - Badge有り、テスト十分 - https://github.com/fictionbase/monitor - Badge有り、テスト十分、README充実 - https://github.com/faultline/faultline

#### まとめ - OSSにてCircleCIを利用する理由について考察 <!-- .element: class="fragment" --> - CircleCIを利用して安定した品質を保証 <!-- .element: class="fragment" --> - Badgeを表示して利用者へソフトウェアの健全性をアピール <!-- .element: class="fragment" -->

Thank you! Fusicは技術が大好きなエンジニアを募集しています  https://fusic.github.io