Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ドキュメントの修正 #45

Merged
merged 1 commit into from
Jan 22, 2024
Merged

ドキュメントの修正 #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ npm run cdk:deploy
> [!NOTE]
> 開発環境を構築する際は、本番環境を上書きしないよう `-c` で `stage` を使用してください。
> ```bash
> npm run cdk:deploy -c stage=<stage>
> npm run cdk:deploy -- -c stage=<stage>
> ```

アプリケーションのデプロイが完了したら、コンソールに出力される `WebUrl` の URL からアクセスしてください。コンソールの出力をとり漏らした場合は、 AWS Console にログインし次の手順で確認してください。
Expand Down
6 changes: 6 additions & 0 deletions docs/DEVELOPMENT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ CDK ではバックエンドの変更をリアルタイムにデプロイし反
npm run cdk:watch
```

環境を指定する際は、`-c` で `stage` を使用してください。

```bash
npm run cdk:watch -- -c stage=<stage>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

package.jsoin で cdk:watch が npm -w packages/cdk run cdk watch -- まで登録されていますが、その状態でも -- 必要そうでしょうか? (-c stage=<stage> だけでよいかなと)

Copy link
Contributor Author

@maekawataiki maekawataiki Jan 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ややこしいですが、
最初のコマンドにある -- は npm run ではなく package.json に登録されている scripts の cdk:watch に渡すための引数であること示しています。
scripts の cdk:watch にある -- は npm -w packages/cdk run ... の引数ではなく cdk watch に渡すための引数であることを示しています。
両方指定しないと最後の cdk watch に引数が渡されません。

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

了解しました！マージします。

```

裏ではファイルの変更がモニタされ Lambda への変更はホットスワップデプロイが実行され、CDK の更新なしにバックエンドにデプロイすることが可能です。その他の変更は通常の CloudFormation の完全なデプロイにフォールバックします。
詳細ついては [CDK Workshop](https://cdkworkshop.com/ja/20-typescript/30-hello-cdk/300-cdk-watch.html#cdk-watch) をご確認ください。

Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"web:build": "npm -w packages/web run build",
"web:lint": "npm -w packages/web run lint",
"cdk:deploy": "npm -w packages/cdk run cdk deploy --",
"cdk:watch": "npm -w packages/cdk run cdk watch",
"cdk:watch": "npm -w packages/cdk run cdk watch --",
"cdk:lint": "npm -w packages/cdk run lint"
},
"devDependencies": {
Expand Down