Merge pull request #274 from rmrk-team/docs-flow

Docs flow

Author: Swader

.github/workflows/npm-publish.yml

@@ -0,0 +1,45 @@
+name: Publish npm package
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: "1.3.4"
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Run tests
+        run: bun run test
+
+      - name: Build artifacts
+        run: bun run build:artifacts
+
+      - name: Check npm version
+        id: npm
+        run: |
+          publish=$(bun -e "const pkg=require('./package.json'); const res=await fetch('https://registry.npmjs.org/' + encodeURIComponent(pkg.name)); if (!res.ok) { console.log('true'); } else { const data=await res.json(); console.log(data.versions && data.versions[pkg.version] ? 'false' : 'true'); }")
+          echo "publish=$publish" >> $GITHUB_OUTPUT
+
+      - name: Configure npm auth
+        if: steps.npm.outputs.publish == 'true'
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
+
+      - name: Publish
+        if: steps.npm.outputs.publish == 'true'
+        run: bun publish --access public

.github/workflows/prettier.yml

@@ -8,10 +8,10 @@ jobs:
   prettier:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Run prettier
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
         with:
-          node-version: "18"
-      - run: yarn install
-      - run: yarn prettier
+          bun-version: "1.3.4"
+      - run: bun install --frozen-lockfile
+      - run: bun run prettier

.github/workflows/release-package.yml

@@ -8,10 +8,10 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Run unit tests
-        uses: actions/setup-node@v1
+      - uses: actions/checkout@v4
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
         with:
-          node-version: "18"
-      - run: yarn install
-      - run: npx hardhat test
+          bun-version: "1.3.4"
+      - run: bun install --frozen-lockfile
+      - run: bun run test

.github/workflows/run-tests.yml

@@ -1,15 +1,24 @@
 node_modules
 .env
+.env.local
+.env.*.local
 coverage
 coverage.json
 typechain
 typechain-types
 temp
 .idea
+.DS_Store
+*.log
+*.tsbuildinfo
 
 #Hardhat files
 cache
 artifacts
 
+#Next.js
+.next
+out
+
 #sec notes
 sec-review.md

.gitignore

@@ -10,17 +10,54 @@ A set of Solidity smart contracts implementing [RMRK](https://rmrk.app) modular
 To use the RMRK legos and smart contracts contained in this repository, simply add them to your project:
 
 ```shell
-yarn add @rmrk-team/evm-contracts
+bun add @rmrk-team/evm-contracts
 ```
 
-or
+Once the dependency is added to your project, simply import the smart contracts you wish to utilize into your own smart
+contract.
+
+## Development
 
 ```shell
-npm -i @rmrk-team/evm-contracts
+bun install
+bun run docs:import
+bun run test
+bun run coverage
+bun run build:artifacts
+bun run docs:prepare
+bun run docs:build
 ```
 
-Once the dependency is added to your project, simply import the smart contracts you wish to utilize into your own smart
-contract.
+## Docs workflow
+
+Docs are built with Nextra/Next.js using the content in `pages/` plus the contract docs generated
+from `docs/`:
+
+- `bun run docs:import` pulls the original `evm-docs` pages/components/public assets into this repo
+  (run once, then edit locally).
+- `bun run docs:prepare` runs `hardhat dodoc`, syncs the generated contract docs into
+  `pages/evm-package/`, and generates `_meta.json` navigation.
+- `bun run docs:build` runs `docs:prepare`, then `next build && next export` to emit the static site
+  in `out/`.
+- `bun run docs:dev` runs the local docs dev server.
+
+## Automation
+
+On each push to `master`, Cloudflare Pages builds and deploys the docs using the repo settings from
+the CF UI.
+
+On each published GitHub Release, GitHub Actions publishes the npm package: it installs
+dependencies with Bun, runs `bun run test`, runs `bun run build:artifacts`, and publishes the
+package with `bun publish --access public` when the package version is not already on npm.
+
+Cloudflare Pages settings:
+
+- **Build command**: `bun run docs:build`
+- **Output directory**: `out`
+
+Required secrets for automation:
+
+- `NPM_TOKEN` for npm publishing
 
 ## RMRK Legos
 
@@ -32,7 +69,7 @@ So far we have created 6 modules as ERC proposals, all of which are ERC721 compa
 - Composable & Equippable: [ERC-6220: Composable NFTs utilizing Equippable Parts](https://eips.ethereum.org/EIPS/eip-6220)
 - Soulbound: [ERC-6454: Minimal Transferable NFT detection interface](https://eips.ethereum.org/EIPS/eip-6454)
 - Emotable: [ERC-7409: Public Non-Fungible Tokens Emote Repository](https://eips.ethereum.org/EIPS/eip-7409)
-- Dynamic Attributes: [ERC-7508: Dynamic On-Chain Token Attributes Repository ](https://eips.ethereum.org/EIPS/eip-7508)
-- ERC20-Holder: [ERC-7590: ERC-20 Holder Extension for NFTs ](https://eips.ethereum.org/EIPS/eip-7590)
+- Dynamic Attributes: [ERC-7508: Dynamic On-Chain Token Attributes Repository](https://eips.ethereum.org/EIPS/eip-7508)
+- ERC20-Holder: [ERC-7590: ERC-20 Holder Extension for NFTs](https://eips.ethereum.org/EIPS/eip-7590)
 
 ![RMRK Modules](/img/General_Overview_Modules.png)