mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
c454084eb1
### Describe Your Changes
This is a follow-up PR containing workflow related part of the initial
[PR#6362](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/6362).
It adds spell checking control based on
[cspell](https://github.com/streetsidesoftware/cspell). The related
configs are consolidated under `cspell` directory.
You can add VictoriaMetrics specific terms into `cspell/custom-dict.txt`
(it contains ~30 items atm). All other absent commonly used terms should
be added directly to respective
[cspell-dicts](https://github.com/streetsidesoftware/cspell-dicts/blob/main/CONTRIBUTING.md).
### Checklist
The following checks are **mandatory**:
- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).
---------
Signed-off-by: Arkadii Yakovets <ark@victoriametrics.com>
(cherry picked from commit 92b22581e6)
45 lines
863 B
YAML
45 lines
863 B
YAML
name: pre-commit
|
|
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- cluster
|
|
- master
|
|
paths:
|
|
- 'docs/**'
|
|
push:
|
|
branches:
|
|
- cluster
|
|
- master
|
|
paths:
|
|
- 'docs/**'
|
|
workflow_dispatch:
|
|
|
|
concurrency:
|
|
cancel-in-progress: true
|
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
|
|
|
jobs:
|
|
pre-commit:
|
|
name: Run pre-commit
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Check out Repository
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Set up Python
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.12'
|
|
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 18
|
|
|
|
- name: Install cspell
|
|
run: |
|
|
npm -g install cspell
|
|
make cspell-install
|
|
|
|
- name: Run pre-commit
|
|
uses: pre-commit/action@v3.0.1
|