🐧

Serverless Framework開発用のGitHub Repository Templateを作成してみた

2022/01/07に公開約1,500字

はじめに

こんにちは、クラスメソッド AWS事業本部の筧です。

私の所属しているチームでは、最近リポジトリを Backlog から GitHub にお引越ししています。個人的には GitHub 初心者なので GitHub ならではの機能にで日々遭遇しています。今回は Repository Template という機能に出会ったので、当該機能を使ってチームメンバーがよく使う Serverless Framework のテンプレートを作成して設定してみました。

Repository Templateについて

以下の DevelopersIO ブログが分かりやすかったので、Repository Template をご存知でない方はこちらも参照ください。

https://dev.classmethod.jp/articles/github-template-repository/

やってみた

予めブログ用にアレンジしたテンプレートを Public で作成しておきました。

https://github.com/takaakikakei/blog-template-pte-sls
tree構造は以下のような形です。よく使うパッケージやライブラリの一部もインストール済みです。
.
├── .github
│   └── PULL_REQUEST_TEMPLATE.md
├── .gitignore
├── LICENSE
├── Pipfile
├── Pipfile.lock
├── README.md
├── includes
│   └── state-machines.yml
├── node_modules
├── package-lock.json
├── package.json
├── serverless.yml
└── src
    ├── __init__.py
    ├── exception.py
    ├── handlers
    │   ├── __init__.py
    │   └── handler.py
    ├── services
    │   └── __init__.py
    └── use_cases
        └── __init__.py

こちらをテンプレートの設定にしていきます。
対象のリポジトリでSettings > Optionsを開き、Template repositoryにチェックを入れるだけでテンプレートにできます。チェックを入れると、リポジトリ名の横がPublicからPublic templateに変わりました。簡単ですね!

新しいリポジトリでこちらのテンプレートを利用する時は、下図のようにこちらのテンプレートを選択するだけです。

あとがき

テンプレートを用いることで、メンバー間の環境差異を減らせたり、サービス開発速度が早くなると思います。紹介したテンプレートはとりあえずで作成したので、今後もっと使いやすいように更新していこうと思います。

それではまた!

Discussion

ログインするとコメントできます