feat: update renovate (#235)

# Description Update dependencies to latest. Clean up dependencies that are already listed in `@matterlabs/docs-nuxt-template` Update renovate configuration file.
matter-labs · Oct 7, 2024 · 7d132c6 · 7d132c6
1 parent f4e5093
commit 7d132c6
Show file tree

Hide file tree

Showing 13 changed files with 81 additions and 85 deletions.
diff --git a/.github/workflows/check-pr-title.yaml b/.github/workflows/check-pr-title.yaml
@@ -17,7 +17,7 @@
         statuses: write
         contents: read
       steps:
-        - uses: amannn/action-semantic-pull-request@c3cd5d1ea3580753008872425915e343e351ab54 # v5.2.0
+        - uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5.5.3
           id: lint_pr_title
           env:
             GITHUB_TOKEN: ${{ github.token }}

diff --git a/.github/workflows/checks.yaml b/.github/workflows/checks.yaml
@@ -14,8 +14,8 @@ jobs:
     name: code_format
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: oven-sh/setup-bun@v1
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      - uses: oven-sh/setup-bun@v2
       - name: Install Dependencies
         run: bun install
       - name: Runs Prettier Formatter
@@ -25,8 +25,8 @@ jobs:
     name: spelling
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: oven-sh/setup-bun@v1
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      - uses: oven-sh/setup-bun@v2
       - name: Install Dependencies
         run: bun install
       - name: Runs cSpell Spell Checker
@@ -36,8 +36,8 @@ jobs:
     name: markdown_lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: oven-sh/setup-bun@v1
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      - uses: oven-sh/setup-bun@v2
       - name: Install Dependencies
         run: bun install
       - name: Runs Markdown Linter
@@ -47,8 +47,8 @@ jobs:
     name: code_lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: oven-sh/setup-bun@v1
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      - uses: oven-sh/setup-bun@v2
       - name: Install Dependencies
         run: bun install
       - name: Runs ESLint

diff --git a/.github/workflows/deploy-preview.yml b/.github/workflows/deploy-preview.yml
@@ -19,9 +19,9 @@ jobs:
     outputs:
       output_urls: "${{ steps.preview_deploy.outputs.urls }}"
     steps:
-      - uses: actions/checkout@v4 # v4
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
 
-      - uses: oven-sh/setup-bun@v1
+      - uses: oven-sh/setup-bun@v2
 
       - name: "Install dependencies"
         run: bun install --production --frozen-lockfile

diff --git a/.github/workflows/deploy-prod.yml b/.github/workflows/deploy-prod.yml
@@ -4,6 +4,7 @@ on:
     branches: [main]
 
 env:
+  NUXT_SITE_ENV: production # used for NuxtSEO to disable things like indexing on staging
   HUSKY: 0
   CI: true
 
@@ -21,11 +22,11 @@ jobs:
     runs-on: ubuntu-latest
     environment: production
     steps:
-      - uses: actions/checkout@v4 # v4
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           persist-credentials: false # <--- checking this in commit context
 
-      - uses: oven-sh/setup-bun@v1
+      - uses: oven-sh/setup-bun@v2
 
       - name: "Install dependencies"
         run: bun install --production --frozen-lockfile

diff --git a/.github/workflows/deploy-staging.yml b/.github/workflows/deploy-staging.yml
@@ -23,11 +23,11 @@ jobs:
     environment: staging
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4 # v4
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           ref: "${{ github.event.inputs.ref }}"
 
-      - uses: oven-sh/setup-bun@v1
+      - uses: oven-sh/setup-bun@v2
 
       - name: "Install dependencies"
         run: bun install --production --frozen-lockfile

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -13,15 +13,15 @@ jobs:
     if: ${{ github.event.repository.full_name == github.repository }} && {{ !contains(github.event.head_commit.message, "skip ci") }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4 # v4
+      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
         with:
           fetch-depth: 0
           persist-credentials: false
 
       - uses: actions/setup-node@v4
         with:
           node-version: 'latest'
-      - uses: oven-sh/setup-bun@v1
+      - uses: oven-sh/setup-bun@v2
 
       - name: "Install dependencies"
         run: bun install --production --frozen-lockfile

diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1,2 @@
 
-bun install
-git add bun.lockb
 bun lint-staged
diff --git a/.markdownlint.json b/.markdownlint.json
@@ -13,6 +13,7 @@
   "MD033": false,
   "MD003": false,
   "MD034": false,
+  "MD036": false,
   "MD024": false,
   "MD022": false,
   "MD023": false,

diff --git a/bun.lockb b/bun.lockb
diff --git a/content/00.build/65.developer-reference/12.addresses/80.zk-chain-addresses.md b/content/00.build/65.developer-reference/12.addresses/80.zk-chain-addresses.md
@@ -59,6 +59,7 @@ Chains:
 ### STM (custom )
 
 ZK Chains:
+
 | name            | chain_id  |  address                                                                                                                      |
 | --------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------- |
 | Cronos testnet  | 282       | [0xeBf961DC3904725ec916678D875B9625d5F7C29f](https://sepolia.etherscan.io/address/0xeBf961DC3904725ec916678D875B9625d5F7C29f) |
diff --git a/nuxt.config.ts b/nuxt.config.ts
@@ -1,10 +1,10 @@
 // https://nuxt.com/docs/api/configuration/nuxt-config
 export default defineNuxtConfig({
   extends: ['@matterlabs/docs-nuxt-template'],
-  modules: ['@nuxt/content', '@nuxt/ui', '@nuxt/eslint', '@nuxtjs/seo', 'nuxt-gtag', '@vite-pwa/nuxt'],
+  modules: ['nuxt-gtag', '@vite-pwa/nuxt'],
   site: {
     name: 'ZKsync Docs',
-    url: process.env.NUXT_SITE_ENV ? 'https://staging-docs.zksync.io' : 'https://docs.zksync.io',
+    url: process.env.NUXT_SITE_ENV === 'production' ? 'https://docs.zksync.io' : 'https://staging-docs.zksync.io',
   },
   runtimeConfig: {
     public: {
@@ -84,11 +84,26 @@ export default defineNuxtConfig({
       ],
     },
   },
-  $production: process.env.NUXT_SITE_ENV
-    ? {}
-    : {
-        gtag: {
-          id: 'G-ELFWXSL45V',
+  icon: {
+    clientBundle: {
+      // scan all components in the project and include icons
+      scan: true,
+      // include all custom collections in the client bundle
+      includeCustomCollections: true,
+      // guard for uncompressed bundle size, will fail the build if exceeds
+      sizeLimitKb: 256,
+    },
+  },
+  $production:
+    process.env.NUXT_SITE_ENV === 'production'
+      ? {
+          gtag: {
+            id: 'G-ELFWXSL45V',
+          },
+        }
+      : {
+          gtag: {
+            enabled: false,
+          },
         },
-      },
 });
diff --git a/package.json b/package.json
@@ -5,43 +5,30 @@
   "version": "0.0.0",
   "license": "MIT",
   "devDependencies": {
-    "@commitlint/cli": "^19.4.1",
-    "@commitlint/config-conventional": "^19.4.1",
-    "@types/bun": "^1.1.8",
-    "@vue/test-utils": "^2.4.6",
-    "cspell": "^8.14.2",
-    "eslint": "^8.57.0",
-    "husky": "^9.1.5",
-    "lint-staged": "^15.2.10",
-    "markdownlint": "^0.33.0",
-    "markdownlint-cli2": "^0.12.1",
-    "nuxt": "^3.13.1",
-    "particles.vue3": "^2.12.0",
-    "prettier": "^3.3.3",
-    "prettier-plugin-tailwindcss": "^0.5.14",
-    "typescript": "^5.5.4",
-    "vue-tsc": "^2.1.6"
+    "@commitlint/cli": "19.5.0",
+    "@commitlint/config-conventional": "19.5.0",
+    "@types/bun": "1.1.10",
+    "@vue/test-utils": "2.4.6",
+    "cspell": "8.14.4",
+    "eslint": "9.11.1",
+    "husky": "9.1.6",
+    "lint-staged": "15.2.10",
+    "markdownlint": "0.35.0",
+    "markdownlint-cli2": "0.14.0",
+    "nuxt": "3.13.2",
+    "prettier": "3.3.3",
+    "prettier-plugin-tailwindcss": "0.6.8",
+    "typescript": "5.6.2",
+    "vue-tsc": "2.1.6"
   },
   "dependencies": {
-    "@iconify-json/heroicons": "^1.2.0",
-    "@iconify-json/simple-icons": "^1.2.1",
-    "@iconify-json/vscode-icons": "^1.2.0",
-    "@matterlabs/docs-nuxt-template": "^2.9.1",
-    "@nuxt/content": "^2.13.2",
-    "@nuxt/eslint": "^0.5.5",
-    "@nuxt/fonts": "^0.3.0",
-    "@nuxt/image": "^1.8.0",
-    "@nuxt/ui-pro": "^1.4.1",
-    "@nuxtjs/seo": "^2.0.0-rc.20",
-    "@tsparticles/slim": "^3.5.0",
-    "@tsparticles/vue3": "^3.0.1",
-    "@vite-pwa/nuxt": "^0.8.1",
-    "nuxt-gtag": "^2.1.0",
-    "nuxt-headlessui": "^1.2.0",
-    "nuxt-og-image": "^3.0.0-rc.66",
-    "rehype-katex": "^7.0.1",
-    "remark-math": "^6.0.0",
-    "vue-easy-lightbox": "^1.19.0"
+    "@matterlabs/docs-nuxt-template": "2.9.2",
+    "@tsparticles/slim": "3.5.0",
+    "@tsparticles/vue3": "3.0.1",
+    "@vite-pwa/nuxt": "0.10.5",
+    "nuxt-gtag": "3.0.1",
+    "rehype-katex": "7.0.1",
+    "remark-math": "6.0.0"
   },
   "scripts": {
     "build": "nuxt generate",
@@ -58,7 +45,6 @@
   },
   "stackblitz": {
     "installDependencies": true,
-    "startCommanad": "bun run dev",
-    "corsProxy": true
+    "startCommanad": "bun run dev"
   }
 }
diff --git a/renovate.json b/renovate.json
@@ -1,38 +1,36 @@
 {
-  "extends": [
-    "github>nuxt/renovate-config-nuxt",
-    "config:recommended",
-    "group:allNonMajor",
-    ":semanticCommitTypeAll(chore)"
-  ],
+  "extends": ["config:best-practices", ":semanticCommitTypeAll(chore)", "group:allNonMajor"],
   "timezone": "Europe/London",
-  "schedule": ["every weekend"],
+  "schedule": ["before 5am on monday"],
   "semanticCommits": "enabled",
+  "npm": {
+    "minimumReleaseAge": "1 week"
+  },
+  "lockFileMaintenance": {
+    "enabled": true,
+    "automerge": true
+  },
+  "separateMajorMinor": true,
   "packageRules": [
     {
       "groupName": "Nuxt Dependencies",
       "groupSlug": "template-deps",
       "matchPackageNames": [
         "@matterlabs/docs-nuxt-template",
         "@iconify-json/**",
-        "@nuxt**",
-        "nuxt**",
+        "/@*(nuxt)(js)*/",
         "vue-easy-lightbox",
-        "@docsearch/**",
         "rehype-katex",
         "remark-math",
-        "dayjs"
+        "@tsparticles/**",
+        "@vite-pwa/nuxt"
       ]
     },
-    {
-      "groupName": "ZK Dependencies",
-      "groupSlug": "zk-deps",
-      "matchPackageNames": ["ethers", "hardhat", "zksync-ethers"]
-    },
     {
       "groupName": "Tooling Dependencies",
       "groupSlug": "tooling-deps",
       "matchPackageNames": [
+        "@types/bun",
         "eslint",
         "@commitlint/**",
         "cspell",
@@ -42,11 +40,7 @@
         "markdownlint**",
         "prettier**",
         "typescript",
-        "vue-tsc",
-        "@playwright/test",
-        "@vue/test-utils",
-        "node-pty",
-        "pm2"
+        "vue-tsc"
       ]
     }
   ]