AWS Amplify で monorepo を導入し 単一リポジトリで複数プロジェクトをデプロイ

AWS Amplify で monorepo を導入し 単一リポジトリで複数プロジェクトをデプロイ

2022-02-255 min read

目次

  1. 概要
  2. monorepoとは
  3. なぜmonorepoにしたのか
  4. amplify-プロジェクト初期化
  5. 参考にしたサイト

概要

amplifyのプロジェクトでmonorepo化を実現しました。

(単一リポジトリで複数のフロントエンドを構築する)

環境

この作業は以下の環境で実施しています。

  • macOS 12.1
  • node v17.5.0
  • typescript 4.3.5
  • amplify-cli 7.6.21

monorepoとは

複数のプロジェクトを1つのリポジトリで管理する開発方式です。

最近目にする回数が多くなったので新しい概念と思いきや、 20年以上前からある考えであり、"shared codebase" と呼ばれています。

In version control systems, a monorepo is a software development strategy where code for many projects is stored in the same repository.

https://en.wikipedia.org/wiki/Monorepo

Google Facebook でもこの方式を採用しています。

なぜmonorepoにしたのか?

なぜmonorepo化にしたのか、、、それは

  1. 複数のフロントエンドとバックエンドをtypescriptで構築しinterfaceを共有する
  2. 1つのリポジトリに統一しプロジェクト全体の見通しを良くする
  3. 複数の環境へのステージングを1つのパイプラインに乗せたい

といった理由があったからです。

Amplify プロジェクト初期化

流れ

  1. リポジトリに2つのプロジェクトの構成を構築する
  2. Amplify上でフロントエンドアプリケーションを1つ作成しリポジトリを連携
  3. Amplify上でフロントエンドアプリケーションの2つめを作成しリポジトリを連携

リポジトリの作成

リポジトリの構成を次の様に構築します。

※ フロントエンドにNextJSを利用しました。

https://docs.amplify.aws/guides/hosting/nextjs/q/platform/js/

.
├── README.md
├── amplify
├── amplify.yml
├── frontApp1
│   ├── README.md
│   ├── next-env.d.ts
│   ├── next.config.js
│   ├── node_modules
│   ├── package-lock.json
│   ├── package.json
│   ├── pages
│   ├── public
│   ├── styles
│   └── tsconfig.json
└── frontApp2
    ├── README.md
    ├── next-env.d.ts
    ├── next.config.js
    ├── node_modules
    ├── package-lock.json
    ├── package.json
    ├── pages
    ├── public
    ├── styles
    └── tsconfig.json

またamplify.ymlを次の様に記載します。

version: 1
applications:
  - appRoot: frontApp1
    frontend:
      phases:
        preBuild:
          commands:
            - npm install
        build:
          commands:
            - npm run build
      artifacts:
        baseDirectory: .next
        files:
          - '**/*'
      cache:
        paths:
          - node_modules/**/*
  - appRoot: frontApp2
    frontend:
      phases:
        preBuild:
          commands:
            - npm install
        build:
          commands:
            - npm run build
      artifacts:
        baseDirectory: .next
        files:
          - '**/*'
      cache:
        paths:
          - node_modules/**/*

リポジトリの連携〜monorepoの選択

リポジトリを連携する画面のcheckboxでmonorepoを選択できます。

これによりビルド時の環境変数として以下の変数が追加されます。

AMPLIFY_MONOREPO_APP_ROOT=frontApp1 # もしくはfrontApp2
AMPLIFY_DIFF_DEPLOY=false

それ以外の項目は通常プロジェクトと同じ様に構築していきます。

完了

2つのプロジェクトの作成が完了するとマネジメントコンソール上ではこのように表示されます。

参考にしたサイト

Tags
javascript(103)
linux(54)
amazon%20aws(47)
node.js(43)
%E3%82%A2%E3%83%AB%E3%82%B4%E3%83%AA%E3%82%BA%E3%83%A0(36)
typescript(33)
%E7%94%BB%E5%83%8F%E5%87%A6%E7%90%86(30)
html5(29)
php(24)
centos(24)
python(22)
%E7%AB%B6%E6%8A%80%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0(21)
mac(21)
mysql(19)
canvas(18)
opencv(17)
%E9%9B%91%E8%AB%87(16)
docker(16)
wordpress(15)
atcoder(14)
apache(12)
%E6%A9%9F%E6%A2%B0%E5%AD%A6%E7%BF%92(12)
%E3%83%87%E3%83%BC%E3%82%BF%E3%83%99%E3%83%BC%E3%82%B9(12)
amazon%20s3(12)
red%20hat(12)
ubuntu(11)
github(10)
git(10)
vue.js(10)
%E7%94%BB%E5%83%8F%E5%87%A6%E7%90%86100%E6%9C%AC%E3%83%8E%E3%83%83%E3%82%AF(10)
mariadb(10)
aws%20cdk(9)
css3(8)
%E5%8F%AF%E8%A6%96%E5%8C%96(8)
%E5%B0%8F%E3%83%8D%E3%82%BF(8)
amazon%20lightsail(7)
react(7)
%E3%83%96%E3%83%AD%E3%82%B0(6)
cms(6)
oracle(6)
perl(6)
gitlab(6)
next.js(6)
prisma(6)
iam(5)
amazon%20ec2(5)
%E8%B3%87%E6%A0%BC%E8%A9%A6%E9%A8%93(5)
aws%20amplify(5)
nestjs(5)
curl(4)
Author
githubzennqiita
ただの備忘録です。※このブログの内容は個人の見解であり、所属する組織等の見解ではないです。