improve test run result

.github/workflows/hardhat.yml

@@ -26,6 +26,20 @@ jobs:
         run: npx hardhat coverage --sources XdefiToCtrlMigration.sol
         working-directory: ./migration
 
+      - name: Markdown autodocs
+      - uses: dineshsonachalam/[email protected]
+        with:
+          # Optional, but recommended
+          # Defaults to "Apply automatic changes"
+          commit_message: Updated results
+
+          # Optional output file paths, defaults to '[./README.md]'.
+          output_file_paths: '[./README.md]'
+
+          # Categories to automatically sync or transform its contents in the markdown files.
+          # Defaults to '[code-block,json-to-html-table,workflow-artifact-table]'
+          categories: '[code-block,json-to-html-table,workflow-artifact-table]'
+
     env:
         PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
         BOB_PRIVATE_KEY: ${{ secrets.BOB_PRIVATE_KEY }}

migration/README.md

@@ -11,3 +11,9 @@ REPORT_GAS=true npx hardhat test
 npx hardhat node
 npx hardhat ignition deploy ./ignition/modules/Lock.ts
 ```
+
+<!-- MARKDOWN-AUTO-DOCS:START (CODE:src=./gas-report.md) -->
+<!-- MARKDOWN-AUTO-DOCS:END -->
+
+<!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./coverage.json) -->
+<!-- MARKDOWN-AUTO-DOCS:END -->

migration/hardhat.config.ts

@@ -31,6 +31,7 @@ const config: HardhatUserConfig = {
     L1: "ethereum",
     gasPriceApi: `https://api.etherscan.io/api?module=proxy&action=eth_gasPrice&apikey=${ETHERSCAN_API_KEY}`,
     coinmarketcap: COINMARKETCAP_API_KEY,
+    reportFormat: "markdown",
   },
   etherscan: {
     apiKey: {