ci: check typos (#957)

Signed-off-by: tison <wander4096@gmail.com>

.github/workflows/linter.yml

@@ -0,0 +1,21 @@
+name: Linters
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+
+jobs:
+  linter:
+    name: Run Linters
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Markdown lint
+      uses: nosborn/github-action-markdown-cli@v3.2.0
+      with:
+        files: "./**/*.md"
+        config_file: .markdownlint.yaml
+    - name: Check typos
+      uses: crate-ci/typos@master

.github/workflows/node.js.yml → .github/workflows/node-build.yml

@@ -17,13 +17,13 @@ jobs:
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install pnpm
-        uses: pnpm/action-setup@v2
+        uses: pnpm/action-setup@v4
         with:
           version: 8.6.0
       - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'pnpm'

.github/workflows/pr-title-checker.yml → .github/workflows/semantic-pull-request.yml

@@ -1,4 +1,5 @@
-name: "PR Title Checker"
+name: Semantic Pull Request
+
 on:
   pull_request_target:
     types:
@@ -10,11 +11,10 @@ on:
 
 jobs:
   check:
+    name: Check pull request title
     runs-on: ubuntu-latest
     timeout-minutes: 10
     steps:
-      - uses: thehanimo/pr-title-checker@v1.3.4
-        with:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          pass_on_octokit_error: false
-          configuration_path: ".github/pr-title-checker-config.json"

docs/nightly/en/contributor-guide/frontend/distributed-querying.md

@@ -15,7 +15,7 @@ Planner will traverse the input logical plan, and split it into multiple stages
 rule](https://github.com/GreptimeTeam/greptimedb/blob/main/docs/rfcs/2023-05-09-distributed-planner.md)".
 
 This rule is under heavy development. At present it will consider things like:
-- whether the operator ifself is commutative
+- whether the operator itself is commutative
 - how the partition rule is configured
 - etc...
 

docs/nightly/en/db-cloud-shared/quick-start/influxdb.md

@@ -1,2 +1,2 @@
 
-To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol).
+To quickly get started with InfluxDB line protocol, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-influxdb-line-protocol).

docs/nightly/en/db-cloud-shared/quick-start/mysql.md

@@ -1,3 +1,3 @@
 
-To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is avaliable on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql).
+To quickly get started with MySQL, we can use Bash to collect system metrics, such as CPU and memory usage, and send it to GreptimeDB via MySQL CLI. The source code is available on [GitHub](https://github.com/GreptimeCloudStarters/quick-start-mysql).
 

docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/go-demo.md

@@ -11,7 +11,7 @@ go get go.opentelemetry.io/otel@v1.16.0 \
 ```
 
 Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB in `app.go`.
-For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
+For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
 
 ```go
 auth := base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", *username, *password)))

docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/java-demo.md

@@ -21,7 +21,7 @@ dependencies {
 }
 ```
 
-Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
+Once the required packages are installed, write the code to create a metric export object that sends metrics to GreptimeDB. For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
 
 ```java
 String endpoint = String.format("https://%s/v1/otlp/v1/metrics", dbHost);

docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/node-js-demo.md

@@ -25,7 +25,7 @@ npm install @opentelemetry/api@1.4.1 \
 ```
 
 Once the required packages are installed,create a new file named `app.ts` and write the code to create a metric export object that sends metrics to GreptimeDB.
-For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
+For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
 
 ```ts
 const exporter = new OTLPMetricExporter({

docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/prometheus-demo.md

@@ -53,7 +53,7 @@ remote_write:
       password: <password>
 ```
 
-The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configration about `<host>`, `<dbname>`, `<username>`, and `<password>`, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md).
+The configuration file above configures Prometheus to scrape metrics from the node exporter and send them to GreptimeDB. For the configuration about `<host>`, `<dbname>`, `<username>`, and `<password>`, please refer to the Prometheus documentation in [GreptimeDB](/user-guide/clients/prometheus.md) or [GreptimeCloud](/greptimecloud/integrations/prometheus/quick-setup.md).
 
 Finally, start the containers:
 

docs/nightly/en/db-cloud-shared/tutorials/monitor-host-metrics/python-demo.md

@@ -25,7 +25,7 @@ pip install -r requirements.txt
 ```
 
 Once the required packages are installed,create a new file named `main.py` and write the code to create a metric export object that sends metrics to GreptimeDB.
-For the configration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
+For the configuration about the exporter, please refer to OTLP integration documentation in [GreptimeDB](/user-guide/clients/otlp.md) or [GreptimeCloud](/greptimecloud/integrations/otlp.md).
 
 ```python
 from opentelemetry import metrics

docs/nightly/en/getting-started/installation/greptimedb-dashboard.md

@@ -2,7 +2,7 @@
 
 Visualization plays a crucial role in effectively utilizing time series data. To help users leverage the various features of GreptimeDB, Greptime offers a simple [dashboard](https://github.com/GreptimeTeam/dashboard).
 
-The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports mutiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md).
+The Dashboard is embedded into GreptimeDB's binary since GreptimeDB v0.2.0. After starting [GreptimeDB Standalone](greptimedb-standalone.md) or [GreptimeDB Cluster](greptimedb-cluster.md), the dashboard can be accessed via the HTTP endpoint `http://localhost:4000/dashboard`. The dashboard supports multiple query languages, including [SQL queries](/user-guide/query-data/sql.md), [Python Scripts](/user-guide/python-scripts/overview.md), and [PromQL queries](/user-guide/query-data/promql.md).
 
 We offer various chart types to choose from based on different scenarios. The charts become more informative when you have sufficient data.
 

docs/nightly/en/reference/command-lines.md

@@ -39,7 +39,7 @@ Starts GreptimeDB in standalone mode with customized configurations:
 greptime --log-dir=/tmp/greptimedb/logs --log-level=info standalone start -c config/standalone.example.toml
 ```
 
-The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuraiton files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md).
+The `standalone.example.toml` configuration file comes from the `config` directory of the `[GreptimeDB](https://github.com/GreptimeTeam/greptimedb/)` repository. You can find more example configuration files there. The `-c` option specifies the configuration file, for more information check [Configuration](../user-guide/operations/configuration.md).
 
 To start GreptimeDB in distributed mode, you need to start each component separately. The following commands show how to start each component with customized configurations or command line arguments.
 

docs/nightly/en/reference/sql/copy.md

@@ -145,7 +145,7 @@ COPY DATABASE <db_name>
 | `FORMAT` | Export file format, available options: JSON, CSV, Parquet  | **Required** |
 | `START_TIME`/`END_TIME`| The time range within which data should be exported. `START_TIME` is inclusive and `END_TIME` is exclusive. | Optional |
 
-> - When copying databses, `<PATH>` must end with `/`.
+> - When copying databases, `<PATH>` must end with `/`.
 > - `CONNECTION` parameters can also be used to copying databases to/from object storage services like AWS S3.
 
 ### Examples

docs/nightly/en/reference/sql/range.md

@@ -322,7 +322,7 @@ Suppose we have a tale `host` with the following data:
 +---------------------+-------+------+
 ```
 
-The following SQL uses `host` as the aggragate key:
+The following SQL uses `host` as the aggregate key:
 
 ```sql
 SELECT 

docs/nightly/en/user-guide/client-libraries/java.md

@@ -387,7 +387,7 @@ For fully runnable code snippets and the complete code of the demo, please refer
 Java database connectivity (JDBC) is the JavaSoft specification of a standard application programming interface (API) that allows Java programs to access database management systems.
 
 Many databases, such as MySQL or PostgreSQL, have implemented their own drivers based on the JDBC API.
-Since GreptimeDB supports [mutiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC.
+Since GreptimeDB supports [multiple protocols](/user-guide/clients/overview.md), we use MySQL as an example to demonstrate how to use JDBC.
 If you want to use other protocols, just replace the MySQL driver with the corresponding driver.
 
 %}

docs/nightly/en/user-guide/clients/influxdb-line.md

@@ -6,7 +6,7 @@ GreptimeDB is compatible with InfluxDB's line protocol authentication format, bo
 
 **[V2 protocol](https://docs.influxdata.com/influxdb/v1.8/tools/api/?t=Auth+Enabled#apiv2query-http-endpoint)**
 
-InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protcol.
+InfluxDB's V2 protocol uses a format much like HTTP's standard basic authentication scheme. We can write data easily through InfluxDB's line protocol.
 
 ```shell
 ❯ curl 'http://localhost:4000/v1/influxdb/api/v2/write?db=public' \

docs/nightly/en/user-guide/cluster.md

@@ -2,7 +2,7 @@
 
 ## Create a cluster
 
-Please refer to [Kubernetes](./operations/kubernetes.md) to get the infomation about creating a Kubernetes cluster.
+Please refer to [Kubernetes](./operations/kubernetes.md) to get the information about creating a Kubernetes cluster.
 
 ## Distributed Read/Write
 

docs/nightly/en/user-guide/concepts/overview.md

@@ -1,6 +1,6 @@
 # Overview
 
-- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performence, and user-friendly.
+- [Why GreptimeDB](./why-greptimedb.md): This document outlines the features and benefits of GreptimeDB, including its flexible architecture that allows for deployment in various environments, from embedded to cloud-native. GreptimeDB is also cost-effective, high-performance, and user-friendly.
 - [Data Model](./data-model.md): This document describes the data model of GreptimeDB, including table schema, index columns, etc.
 - [Architecture](./architecture.md): Get the cloud-native architecture of GreptimeDB.
 - [Storage Location](./storage-location.md): This document describes the storage location of GreptimeDB, including local disk, HDFS, and cloud object storage such as S3, Azure Blob Storage, etc.

docs/nightly/en/user-guide/migrate-to-greptimedb/migrate-from-influxdb.md

@@ -160,7 +160,7 @@ $writeApi->write($point);
 %}
 
 {template visualize-data%
-It is recommanded using Grafana to visualize data in GreptimeDB.
+It is recommended using Grafana to visualize data in GreptimeDB.
 Please refer to the [Grafana documentation](/user-guide/clients/grafana) for details on configuring GreptimeDB.
 %}
 

docs/nightly/en/user-guide/python-scripts/getting-started.md

@@ -14,7 +14,7 @@ conda create --name Greptime python=<Specific Python Version from above step, e.
 conda activate Greptime
 ```
 
-You may have to adjust the correct `LD_LIBRARY_PATH` for your Python shared library. For example, in the conda environment, set `LD_LIBRARY_PATH` (or `DYLD_LIBRARY_PATH`) to `$CONDA_PREFIX/lib`. To ensure the correct Python shared library is in this path, run `ls $CONDA_PREFIX/lib | grep 'libpython'` and verifty that the version is correct.
+You may have to adjust the correct `LD_LIBRARY_PATH` for your Python shared library. For example, in the conda environment, set `LD_LIBRARY_PATH` (or `DYLD_LIBRARY_PATH`) to `$CONDA_PREFIX/lib`. To ensure the correct Python shared library is in this path, run `ls $CONDA_PREFIX/lib | grep 'libpython'` and verify that the version is correct.
 
 ### Install GreptimeDB
 

docs/nightly/en/user-guide/query-data/promql.md

@@ -115,7 +115,7 @@ The result format is the same as `/sql` interface described in [query data](sql.
   "execution_time_ms": 5
 }
 ```
-<!-- TODO New paths that compatible with Promethues APIs -->
+<!-- TODO New paths that compatible with Prometheus APIs -->
 
 ## SQL
 

docs/nightly/en/user-guide/table-management.md

@@ -9,7 +9,7 @@ For more explanations of the `SQL` syntax, please see the [SQL reference](/refer
 
 ## Create Database
 
-The default database is `public`. You can create a database manully.
+The default database is `public`. You can create a database manually.
 
 ```sql
 CREATE DATABASE test;

docs/nightly/zh/user-guide/clients/otlp.md

@@ -79,5 +79,5 @@ OTLP 指标数据模型按照下方的规则被映射到 GreptimeDB 数据模型
 - 所有的 Attribute ，包含 resource 级别、scope 级别和 data_point 级别，都被作为 GreptimeDB 表的 tag 列。
 - 数据点的时间戳被作为 GreptimeDB 的时间戳索引，列名 greptime_timestamp。
 - Gauge/Sum 两种类型的数据点数据被作为 field 列，列名 greptime_value。
-- Summay 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如  90 / 99 等。
+- Summary 类型的每个 quantile 被作为单独的数据列，列名 greptime_pxx ，其中 xx 是quantile 的数据，如  90 / 99 等。
 - Histogram 和 ExponentialHistogram 暂时未被支持，我们可能在后续版本中推出 Histogram 数据类型来原生支持这两种类型。

docs/nightly/zh/user-guide/query-data/promql.md

@@ -112,7 +112,7 @@ curl -X GET \
   "execution_time_ms": 5
 }
 ```
-<!-- TODO New paths that compatible with Promethues APIs -->
+<!-- TODO New paths that compatible with Prometheus APIs -->
 
 ## SQL
 

docs/release-notes/release-0-7-0.md

@@ -44,7 +44,7 @@ v0.7 represents a crucial leap toward achieving production readiness; it impleme
 * fix: bump libgit2-sys from 0.16.1+1.7.1 to 0.16.2+1.7.2 by [@dependabot](https://github.com/dependabot) in [#3316](https://github.com/GreptimeTeam/greptimedb/pull/3316)
 * fix: split write metadata request by [@fengjiachun](https://github.com/fengjiachun) in [#3311](https://github.com/GreptimeTeam/greptimedb/pull/3311)
 * fix(index): encode string type to original data to enable fst regex to work by [@zhongzc](https://github.com/zhongzc) in [#3324](https://github.com/GreptimeTeam/greptimedb/pull/3324)
-* fix: disable ansi contorl char when stdout is redirected by [@waynexia](https://github.com/waynexia) in [#3332](https://github.com/GreptimeTeam/greptimedb/pull/3332)
+* fix: disable ansi control char when stdout is redirected by [@waynexia](https://github.com/waynexia) in [#3332](https://github.com/GreptimeTeam/greptimedb/pull/3332)
 * fix: typo in lint config by [@waynexia](https://github.com/waynexia) in [#3358](https://github.com/GreptimeTeam/greptimedb/pull/3358)
 * fix: treat "0" and "1" as valid boolean values. by [@MichaelScofield](https://github.com/MichaelScofield) in [#3370](https://github.com/GreptimeTeam/greptimedb/pull/3370)
 * fix: remove unused imports in memtable_util.rs by [@v0y4g3r](https://github.com/v0y4g3r) in [#3376](https://github.com/GreptimeTeam/greptimedb/pull/3376)

docs/release-notes/release-0-7-1.md

@@ -34,7 +34,7 @@ This is a patch release, containing an important bug fix while decoding the Prom
 * feat: clamp function by [@waynexia](https://github.com/waynexia) in [#3465](https://github.com/GreptimeTeam/greptimedb/pull/3465)
 * feat(fuzz): validate columns by [@WenyXu](https://github.com/WenyXu) in [#3485](https://github.com/GreptimeTeam/greptimedb/pull/3485)
 * feat: to_timezone function by [@tisonkun](https://github.com/tisonkun) in [#3470](https://github.com/GreptimeTeam/greptimedb/pull/3470)
-* feat(flow): accumlator for aggr func by [@discord9](https://github.com/discord9) in [#3396](https://github.com/GreptimeTeam/greptimedb/pull/3396)
+* feat(flow): accumulator for aggr func by [@discord9](https://github.com/discord9) in [#3396](https://github.com/GreptimeTeam/greptimedb/pull/3396)
 * feat(flow): plan def by [@discord9](https://github.com/discord9) in [#3490](https://github.com/GreptimeTeam/greptimedb/pull/3490)
 * feat: improve prom write requests decode performance by [@v0y4g3r](https://github.com/v0y4g3r) in [#3478](https://github.com/GreptimeTeam/greptimedb/pull/3478)
 * feat(fuzz): add insert target by [@zhongzc](https://github.com/zhongzc) in [#3499](https://github.com/GreptimeTeam/greptimedb/pull/3499)

docs/release-notes/release-0-7-2.md

@@ -76,7 +76,7 @@ This is a patch release, containing a critial bug fix to avoid wrongly delete da
 * refactor: introduce the DropTableExecutor by [@WenyXu](https://github.com/WenyXu) in [#3534](https://github.com/GreptimeTeam/greptimedb/pull/3534)
 * refactor: refactor CacheInvalidator by [@WenyXu](https://github.com/WenyXu) in [#3550](https://github.com/GreptimeTeam/greptimedb/pull/3550)
 * refactor: handle error for http format by [@tisonkun](https://github.com/tisonkun) in [#3548](https://github.com/GreptimeTeam/greptimedb/pull/3548)
-* refactor: remove redudant PromStoreProtocolHandler::write  by [@v0y4g3r](https://github.com/v0y4g3r) in [#3553](https://github.com/GreptimeTeam/greptimedb/pull/3553)
+* refactor: remove redundant PromStoreProtocolHandler::write  by [@v0y4g3r](https://github.com/v0y4g3r) in [#3553](https://github.com/GreptimeTeam/greptimedb/pull/3553)
 * refactor: reduce one clone by carefully pass ready boundary by [@tisonkun](https://github.com/tisonkun) in [#3543](https://github.com/GreptimeTeam/greptimedb/pull/3543)
 * refactor: try upgrade regex-automata by [@tisonkun](https://github.com/tisonkun) in [#3575](https://github.com/GreptimeTeam/greptimedb/pull/3575)
 * refactor: refactor drop table executor by [@WenyXu](https://github.com/WenyXu) in [#3589](https://github.com/GreptimeTeam/greptimedb/pull/3589)