Skip to content

Commit 9bf5ba8

Browse files
authored
ci: Add pre-commit workflow (#92)
* ci: Add pre-commit workflow * chore: Remove unused env vars from workflow
1 parent d04e4c3 commit 9bf5ba8

File tree

4 files changed

+82
-0
lines changed

4 files changed

+82
-0
lines changed

.github/workflows/pr_pre-commit.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: pre-commit
3+
4+
on:
5+
pull_request:
6+
7+
jobs:
8+
pre-commit:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
12+
with:
13+
fetch-depth: 0
14+
- uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5.1.0
15+
with:
16+
python-version: '3.12'
17+
- uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
18+
with:
19+
extra_args: "--from-ref ${{ github.event.pull_request.base.sha }} --to-ref ${{ github.event.pull_request.head.sha }}"

.markdownlint.yaml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
# All defaults or options can be checked here:
3+
# https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
4+
5+
# Default state for all rules
6+
default: true
7+
8+
# MD013/line-length - Line length
9+
MD013:
10+
# Number of characters
11+
line_length: 9999
12+
# Number of characters for headings
13+
heading_line_length: 9999
14+
# Number of characters for code blocks
15+
code_block_line_length: 9999
16+
17+
# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
18+
MD024:
19+
# Only check sibling headings
20+
siblings_only: true

.pre-commit-config.yaml

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
default_language_version:
3+
node: system
4+
5+
repos:
6+
- repo: https://github.com/pre-commit/pre-commit-hooks
7+
rev: 2c9f875913ee60ca25ce70243dc24d5b6415598c # 4.6.0
8+
hooks:
9+
- id: trailing-whitespace
10+
- id: end-of-file-fixer
11+
- id: detect-aws-credentials
12+
args: ["--allow-missing-credentials"]
13+
- id: detect-private-key
14+
15+
- repo: https://github.com/adrienverge/yamllint
16+
rev: 81e9f98ffd059efe8aa9c1b1a42e5cce61b640c6 # 1.35.1
17+
hooks:
18+
- id: yamllint
19+
20+
- repo: https://github.com/igorshubovych/markdownlint-cli
21+
rev: f295829140d25717bc79368d3f966fc1f67a824f # 0.41.0
22+
hooks:
23+
- id: markdownlint
24+
25+
- repo: https://github.com/koalaman/shellcheck-precommit
26+
rev: 2491238703a5d3415bb2b7ff11388bf775372f29 # 0.10.0
27+
hooks:
28+
- id: shellcheck
29+
args: ["--severity=info"]
30+
31+
- repo: https://github.com/rhysd/actionlint
32+
rev: 62dc61a45fc95efe8c800af7a557ab0b9165d63b # 1.7.1
33+
hooks:
34+
- id: actionlint

.yamllint.yaml

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
extends: default
3+
4+
rules:
5+
line-length: disable
6+
truthy:
7+
check-keys: false
8+
comments:
9+
min-spaces-from-content: 1 # Needed due to https://github.com/adrienverge/yamllint/issues/443

0 commit comments

Comments
 (0)