From e587df4548a4f8f21b21e08464959b61c0422f16 Mon Sep 17 00:00:00 2001 From: Ad-Bean Date: Tue, 19 Nov 2024 15:46:24 -0500 Subject: [PATCH] feat(ci): typos for spell check (#64) * ci: typos * fix: correct typo in description field * feat: add spellcheck configuration and custom wordlist * feat: add new words to custom wordlist * fix: normalize capitalization of 'Customizations' to 'customizations' in wordlist --- .github/workflows/spellcheck.yml | 56 ++++++++ .spellcheck.yml | 23 ++++ .wordlist.txt | 229 +++++++++++++++++++++++++++++++ cloud/check-spending-details.mdx | 2 +- typos.toml | 19 +++ 5 files changed, 328 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/spellcheck.yml create mode 100644 .spellcheck.yml create mode 100644 .wordlist.txt create mode 100644 typos.toml diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 00000000..0fcdfdf5 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,56 @@ +name: spellcheck +on: + pull_request: + +jobs: + run: + name: Spell Check with Typos + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: typos-action + id: typos-output + uses: crate-ci/typos@v1.27.3 + with: + config: ./typos.toml + + - name: Find Comment + if: ${{ failure() }} + uses: peter-evans/find-comment@v3 + id: find-comment + with: + issue-number: ${{ github.event.pull_request.number }} + comment-author: "github-actions[bot]" + body-includes: The CI check for spelling has failed + + - name: Create comment on PR if typos fail + if: ${{ failure() && steps.find-comment.outputs.comment-id == '' }} + uses: peter-evans/create-or-update-comment@v4 + with: + issue-number: ${{ github.event.pull_request.number }} + body: | + ### CI Check Failed + The CI check for spelling has failed. Please review the errors and correct any spelling mistakes. + + For more errors and details, you can check the [CI Log](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) or you can install [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install) and run `typos` locally to check for and fix spelling issues. + + - name: Update comment if typos fail + if: ${{ failure() && steps.find-comment.outputs.comment-id != '' }} + uses: peter-evans/create-or-update-comment@v4 + with: + comment-id: ${{ steps.find-comment.outputs.comment-id }} + issue-number: ${{ github.event.pull_request.number }} + body: | + ### CI Check Failed + The CI check for spelling has failed. Please review the errors and correct any spelling mistakes. + + For more errors and details, you can check the [CI Log](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}) or you can install [typos](https://github.com/crate-ci/typos?tab=readme-ov-file#install) and run `typos` locally to check for and fix spelling issues. + edit-mode: replace + + - name: Check Spelling + uses: rojopolis/spellcheck-github-actions@0.35.0 + with: + config_path: .spellcheck.yml + task_name: Markdown diff --git a/.spellcheck.yml b/.spellcheck.yml new file mode 100644 index 00000000..35738429 --- /dev/null +++ b/.spellcheck.yml @@ -0,0 +1,23 @@ +matrix: + - name: Markdown + apsell: + ignore-case: true + lang: en + dictionary: + wordlists: + - .wordlist.txt + output: wordlist.dic + encoding: utf-8 + pipeline: + - pyspelling.filters.markdown: + markdown_extensions: + - pymdownx.superfences + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + sources: + - "*.mdx" + - "*.md" + default_encoding: utf-8 diff --git a/.wordlist.txt b/.wordlist.txt new file mode 100644 index 00000000..a9d39701 --- /dev/null +++ b/.wordlist.txt @@ -0,0 +1,229 @@ +https +github +risingwavelabs +RisingWave +Redpanda +Kinesis +Astra +Debezium +debezium +JSON +struct +varchar +TabItem +RailroadDiagram +rr +SSL +SASL +OAUTHBEARER +Docusaurus +docusaurus +Postgres +postgres +datagen +Grafana +Etcd +MinIO +CMake +OpenSSL +psql +RiseDev +Tmux +Kubernetes +frontend +NodePort +kubectl +uptime +Avro +Protobuf +Prebuilt +Observability +CSV +DML +Alluxio +Superset +DBeaver +Jupyter +Metabase +Clickhouse +CockroachDB +DataStax +Pinot +TiDB +Hudi +Trino +Airbyte +Fivetran +Hightouch +dbt +ELT +ETL +DataStax +StreamNative +integrations +macOS +quickstart +substring +substrings +gz +dev +CTEs +namespace +deserialization +scalability +changelog +failover +risingwave +sql +js +rw +pgwire +json +mv +mysql +Redash +JDBC +Redash +analytics +Flink +JVM +APIs +stateful +runtime +disaggregated +PrivateLink +VPCs +VPC +DataSet +FlinkSQL +LSM +natively +ad-hoc +hoc +RocksDB +checkpointing +checkpointed +UDF +APIs +DAGs +acyclic +MapReduce +dataflow +pipelined +RisingWave's +Redash +TiCDC +upsert +JSONB +boolean +Citus +CLI +Chandy +OpenDAL +WebHDFS +ChatGPT +clickstream +cryptocurrency +dataset +HDFS +flink +Flink's +Homebrew +IoT +Lamport +microservice +microservices +multibyte +protobuf +Protobuf +timestamptz +timestamptzs +unary +zstd +http +pre +toc +latencies +thoroughputs +VPC +bigint +bytea +TopN +UDFs +avro +kafka +Paimon +TPC +Greenplum +updateable +ClickHouse +JetStream +MSK +msk +NATS +ScyllaDB +OOM +DataGrip +PgAdmin +clickhouse +Supabase +BigQuery +transactional +OLAP +ksqlDB +backfilling +GraphQL +src +img +jpg +StarRocks +starrocks +md +Bytebase +GCS +gcs +faq +OLTP +Napa +superset +Napa +www +DDL +backfill +backfills +MVs +Nats +Psycopg +Datadog +Hasura +Liquibase +EMQX +HiveMQ +MQTT +RabbitMQ +Standalone's +localhost +prometheus +datasources +OpenSearch +codebase +Databricks +SDKs +RWUs +roadmap +terraform +Serverless +WASM +schemas +risingwavecloud +Rockset +personalization +DefaultButton +LightButton +VoteNotify +SharedMergeTree +JWT +TOML +mintlify +customizations +repo \ No newline at end of file diff --git a/cloud/check-spending-details.mdx b/cloud/check-spending-details.mdx index 68e78c52..3dc0a89e 100644 --- a/cloud/check-spending-details.mdx +++ b/cloud/check-spending-details.mdx @@ -1,6 +1,6 @@ --- title: "Check spending details" -descriptin: You can view the usage and the corresponding charges for each project during the ongoing billing period. You can also download a PDF version of the invoice for your records. +description: You can view the usage and the corresponding charges for each project during the ongoing billing period. You can also download a PDF version of the invoice for your records. --- diff --git a/typos.toml b/typos.toml new file mode 100644 index 00000000..8add8b6b --- /dev/null +++ b/typos.toml @@ -0,0 +1,19 @@ +[default] +extend-ignore-identifiers-re = [ + # base64 + "\\b[0-9A-Za-z+/]{64}(=|==)?\\b", + # ingest/ingest-from-datagen.md + "\\b[0-9A-Za-z]{16}\\b", +] + +[default.extend-identifiers] +# sql/functions-operators/sql-function-string.md +1b69b4ba630f34e = "1b69b4ba630f34e" + +[default.extend-words] +Iy = "Iy" +YTO = "YTO" +# Azure Kubernetes Service +AKS = "AKS" +# schema.history.internal.skip.unparseable.ddl +unparseable="unparseable" \ No newline at end of file