unchain-tech / UNCHAIN-projects

Our open-source projects live here.
https://buidl.unchain.tech/
MIT License
54 stars 86 forks source link

ICP-Encrypted-Notes: Candidファイルの自動生成手順を追加 #450

Closed yk-saito closed 1 year ago

yk-saito commented 1 year ago

変更内容

Candidファイルを手動で作成していましたが、自動生成するようにマークダウンを更新しました。

備考

参考: https://daviddalbusco.medium.com/automatic-candid-generation-in-rust-exploring-the-ic-cdk-v0-10-0-update-d1ad76bd4f69 https://discord.com/channels/748416164832608337/872791506853978142/1153409132716634194

Screen Shot 2023-09-20 at 20 34 13

junkei-okinawa commented 1 year ago

修正後の内容でtest.shをPASSすること確認済。アプリが正常に動作すること確認済。 今回のコンテンツ内容には影響が無いですが、1点、追加の変更提案として、package.jsonの以下の部分も修正したほうが良いと思いました。 理由:.didの変更が発生するようなコード変更を加えた後、npm run generateを実行せずにnpm run deploy:localnpm run deploy:icを実行すると.didに変更内容が反映されない。あるべき状態としてdeploy前に都度 .didを出力する処理になっていたほうが良い(以下変更後の内容で動作確認済)

  "scripts": {
    "build": "webpack",
    "prebuild": "dfx generate",
    "start": "webpack serve --mode development --env development",
-    "deploy:local": "dfx deploy --network=local",
-    "deploy:ic": "dfx deploy --network=ic",
+    "deploy:local": "bash ./scripts/did.sh && dfx deploy --network=local",
+    "deploy:ic": "bash ./scripts/did.sh && dfx deploy --network=ic",
    "generate": "bash ./scripts/did.sh && dfx generate encrypted_notes_backend",
    "test": "bash ./scripts/test.sh"
  },
yk-saito commented 1 year ago

修正後の内容でtest.shをPASSすること確認済。アプリが正常に動作すること確認済。 今回のコンテンツ内容には影響が無いですが、1点、追加の変更提案として、package.jsonの以下の部分も修正したほうが良いと思いました。 理由:.didの変更が発生するようなコード変更を加えた後、npm run generateを実行せずにnpm run deploy:localnpm run deploy:icを実行すると.didに変更内容が反映されない。あるべき状態としてdeploy前に都度 .didを出力する処理になっていたほうが良い(以下変更後の内容で動作確認済)

  "scripts": {
    "build": "webpack",
    "prebuild": "dfx generate",
    "start": "webpack serve --mode development --env development",
-    "deploy:local": "dfx deploy --network=local",
-    "deploy:ic": "dfx deploy --network=ic",
+    "deploy:local": "bash ./scripts/did.sh && dfx deploy --network=local",
+    "deploy:ic": "bash ./scripts/did.sh && dfx deploy --network=ic",
    "generate": "bash ./scripts/did.sh && dfx generate encrypted_notes_backend",
    "test": "bash ./scripts/test.sh"
  },

スクリプトコマンドの修正に伴い、https://github.com/unchain-tech/UNCHAIN-projects/pull/450/commits/009651f9d50088fb01c3d0a9bc5ea2f7c86b1c80 にて実行コマンドを更新いたしました。

参照:https://github.com/unchain-tech/ICP-Encrypted-Notes/pull/16#issuecomment-1728833109

junkei-okinawa commented 1 year ago

スクリプトコマンドの修正に伴い、https://github.com/unchain-tech/UNCHAIN-projects/commit/009651f9d50088fb01c3d0a9bc5ea2f7c86b1c80 にて実行コマンドを更新いたしました。

@yk-saito 修正箇所確認しました。OKです!