From 6f075390f912f61b50674efec8d1f8023ea66225 Mon Sep 17 00:00:00 2001
From: Daniel Wang <99078276+dantaik@users.noreply.github.com>
Date: Thu, 25 Apr 2024 12:28:34 +0800
Subject: [PATCH] chore(repo): update actions versions and customize typo
checking (#16821)
---
.github/_typos.toml | 4 ++++
.github/actions/install-pnpm-dependencies/action.yml | 8 ++++----
.github/workflows/typos.yml | 2 ++
.github/workflows/validate-pr-title.yml | 4 ++--
README.md | 4 +++-
5 files changed, 15 insertions(+), 7 deletions(-)
create mode 100644 .github/_typos.toml
diff --git a/.github/_typos.toml b/.github/_typos.toml
new file mode 100644
index 0000000000..6234b2c783
--- /dev/null
+++ b/.github/_typos.toml
@@ -0,0 +1,4 @@
+[default.extend-words]
+TGE = "TGE"
+TKO = "TKO"
+Ethereum = "Ethereum"
\ No newline at end of file
diff --git a/.github/actions/install-pnpm-dependencies/action.yml b/.github/actions/install-pnpm-dependencies/action.yml
index 5d98115c22..d3fec869f9 100644
--- a/.github/actions/install-pnpm-dependencies/action.yml
+++ b/.github/actions/install-pnpm-dependencies/action.yml
@@ -5,12 +5,12 @@ runs:
using: "composite"
steps:
- name: Setup Node.js
- uses: actions/setup-node@v3
+ uses: actions/setup-node@v4
with:
- node-version: 18
+ node-version: 20
- name: Install pnpm
- uses: pnpm/action-setup@v2
+ uses: pnpm/action-setup@v3
id: pnpm-install
with:
version: 8
@@ -23,7 +23,7 @@ runs:
echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
- name: Setup pnpm cache
- uses: actions/cache@v3
+ uses: actions/cache@v4
with:
path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml
index 2155dc1341..ea5584f3c4 100644
--- a/.github/workflows/typos.yml
+++ b/.github/workflows/typos.yml
@@ -11,3 +11,5 @@ jobs:
- name: Check for typos
uses: crate-ci/typos@master
+ with:
+ config: ${{github.workspace}}/.github/_typos.toml
diff --git a/.github/workflows/validate-pr-title.yml b/.github/workflows/validate-pr-title.yml
index fea00761e3..70240c32d3 100644
--- a/.github/workflows/validate-pr-title.yml
+++ b/.github/workflows/validate-pr-title.yml
@@ -42,8 +42,8 @@ jobs:
taikoon
supplementary-contracts
requireScope: true
- subjectPattern: ^(?![A-Z]).+$ # Require lowercase PR title
+ subjectPattern: ^(?![A-Z])(?!.*\btypo\b).+$ # Require lowercase PR title and prohibit word "typo"
subjectPatternError: |
The subject "{subject}" found in the pull request title "{title}"
didn't match the configured pattern. Please ensure that the subject
- doesn't start with an uppercase character.
+ doesn't start with an uppercase character and doesn't contains word "typo".
diff --git a/README.md b/README.md
index 18e4e52d63..40ed82d51f 100644
--- a/README.md
+++ b/README.md
@@ -44,7 +44,9 @@ taiko-mono/
│ ├── guardian-prover-health-check: Guardian prover health check service.
│ ├── guardian-prover-health-check-ui: Guardian prover health check UI.
│ ├── protocol: Taiko protocol smart contracts.
-│ └── relayer: Bridge backend relayer.
+│ ├── relayer: Bridge backend relayer.
+│ ├── taikoon: Taikoon NFT contracts.
+│ └── supplementary-contracts: Supplementary smart contracts that are not part of the Taiko rollup protocol.
...