Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add non-code linters #29

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/build.yaml
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want we can be more relaxed on this, given the .yaml already existed.

Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
name: Build
on:
"on":
workflow_dispatch:
jobs:
build:
Expand Down
42 changes: 42 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
name: Lint

"on":
push:
branches:
- main
pull_request:
branches:
- "*"
workflow_dispatch: {}

jobs:
lint:
name: Lint

runs-on: ubuntu-24.04

steps:
- uses: actions/[email protected]

- name: markdownlint
uses: DavidAnson/[email protected]
with:
globs: |
*.md
# .github/**/*.md
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not yet available, but maybe soonish 🤷

config: .markdownlint.yaml

- name: yamllint
uses: ibiqlik/[email protected]
with:
file_or_dir: |
.github/**/*.yaml
.*.yaml
strict: true
config_file: .yamllint.yaml

- name: actionlint
uses: reviewdog/[email protected]
env:
SHELLCHECK_OPTS: -o all
3 changes: 2 additions & 1 deletion .github/workflows/update_builds_txt.yaml
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we want we can be more relaxed on this, given the .yaml already existed.

Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
name: Update builds.txt
on:
"on":
workflow_dispatch:
jobs:
build:
Expand Down
4 changes: 4 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
default: true
MD013:
line_length: 100
5 changes: 5 additions & 0 deletions .yamllint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
extends: default
rules:
line-length:
max: 100