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

Check Front Matter #15

Merged
merged 5 commits into from
Nov 4, 2023
Merged
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
89 changes: 61 additions & 28 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,68 @@
name: Test

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
push:
branches: [ main ]
pull_request:
branches: [ main ]

workflow_dispatch:
workflow_dispatch:

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
lint:
name: Lint
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 'lts/*'
- name: Install dependencies
run: npm ci
- name: Run linter
run: npm run sass:lint
- name: Check EditorConfig configuration
run: test -f .editorconfig
- name: Check adherence to EditorConfig
uses: greut/eclint-action@v0
with:
eclint_args: |
-exclude=css/*
- name: Search for misspellings
uses: crate-ci/typos@master
steps:
-
name: Checkout repository
uses: actions/checkout@v3
-
name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 'lts/*'
-
name: Install dependencies
run: npm ci
-
name: Run linter
run: npm run sass:lint
-
name: Check EditorConfig configuration
run: test -f .editorconfig
-
name: Check adherence to EditorConfig
uses: greut/eclint-action@v0
with:
eclint_args: |
-exclude=css/*
-
name: Search for misspellings
uses: crate-ci/typos@master

lint_front_matter:
name: Lint Front Matter
runs-on: ubuntu-latest

steps:
-
name: Checkout repository
uses: actions/checkout@v3
-
name: Cache pip
uses: actions/cache@v3
with:
path: '~/.cache/pip'
key: '${{ runner.os }}-pip-yamllint'
-
name: Install yamllint
run: pip install --user yamllint
-
name: Remove document contents
run: |
git ls-files -z -- 'src/**.md' | xargs -0 -n 1 -- sed -i -e 'N;P;/---\n$/Q;D'
-
name: Check Front Matter
run: |
git ls-files -z -- 'src/**.md' | xargs -0 -n 1 -- python -m yamllint
20 changes: 20 additions & 0 deletions .yamllint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
extends: "default"

rules:
document-start:
present: true
braces:
forbid: true
brackets:
forbid: false
empty-values:
forbid-in-block-mappings: true
forbid-in-flow-mappings: true
indentation:
spaces: 4
indent-sequences: false
line-length: "disable"
quoted-strings:
quote-type: "double"
required: true
8 changes: 4 additions & 4 deletions src/account.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ title: "Account"
layout: "layout/account.html"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Account"
url: null
caption: "Account"
url: null
---

<div class="app-card app-card--info">
Expand Down
8 changes: 4 additions & 4 deletions src/categories.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: "Categories"
layout: "layout/categories.html"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Categories"
url: null
caption: "Categories"
url: null
---
8 changes: 4 additions & 4 deletions src/customers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: "Customers"
layout: "layout/customers.html"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Customers"
url: null
caption: "Customers"
url: null
---
12 changes: 6 additions & 6 deletions src/notifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ layout: "layout/account.html"
permalink: "account/notifications/"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Account"
url: "/account/"
caption: "Account"
url: "/account/"
-
caption: "Notifications"
url: null
caption: "Notifications"
url: null
---

<h3>Notifications</h3>
Expand Down
8 changes: 4 additions & 4 deletions src/orders.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: "Orders"
layout: "layout/orders.html"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Orders"
url: null
caption: "Orders"
url: null
---
12 changes: 6 additions & 6 deletions src/password.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ layout: "layout/account.html"
permalink: "account/password/"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Account"
url: "/account/"
caption: "Account"
url: "/account/"
-
caption: "Password"
url: null
caption: "Password"
url: null
---

<h3>Set up a new password</h3>
Expand Down
12 changes: 6 additions & 6 deletions src/product-edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ layout: "layout/product-edit.html"
permalink: "product/edit/"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Products"
url: "/products/"
caption: "Products"
url: "/products/"
-
caption: "Edit"
url: null
caption: "Edit"
url: null
---
8 changes: 4 additions & 4 deletions src/products.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: "Products"
layout: "layout/products.html"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Products"
url: null
caption: "Products"
url: null
---
12 changes: 6 additions & 6 deletions src/profile.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ layout: "layout/account.html"
permalink: "account/profile/"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Account"
url: "/account/"
caption: "Account"
url: "/account/"
-
caption: "Profile"
url: null
caption: "Profile"
url: null
---

<h3>Personal Information</h3>
Expand Down
8 changes: 4 additions & 4 deletions src/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: "Settings"
layout: "layout/settings.html"
breadcrumbs:
-
caption: "Dashboard"
url: "/"
caption: "Dashboard"
url: "/"
-
caption: "Settings"
url: null
caption: "Settings"
url: null
---