Skip to content

Commit

Permalink
finos#535: Add yamllint to lint yaml files
Browse files Browse the repository at this point in the history
  • Loading branch information
dogle-scottlogic committed Nov 15, 2024
1 parent 36310ae commit d4a71db
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 4 deletions.
4 changes: 2 additions & 2 deletions .config/.markdownlint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ MD022:
MD023: true

# MD024/no-duplicate-heading : Multiple headings with the same content : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md024.md
MD024:
MD024:
siblings_only: true

# MD025/single-title/single-h1 : Multiple top-level headings in the same document : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md025.md
Expand Down Expand Up @@ -246,4 +246,4 @@ MD055:
style: "consistent"

# MD056/table-column-count : Table column count : https://github.com/DavidAnson/markdownlint/blob/v0.34.0/doc/md056.md
MD056: true
MD056: true
7 changes: 7 additions & 0 deletions .config/.yamllint
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
extends: default

rules:
indentation:
spaces: 2 # Enforce 2 spaces for indentation
line-length:
max: 120 # Allow up to 120 characters per line
23 changes: 22 additions & 1 deletion .github/workflows/linting-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,25 @@ jobs:
run: npm install -g markdownlint-cli

- name: Run markdownlint
run: markdownlint '**/*.md' --config ./.config/.markdownlint.yaml
run: markdownlint '**/*.md' --config ./.config/.markdownlint.yaml

yaml-lint:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.x" # Use any compatible Python 3 version

- name: Install yamllint
run: |
python -m pip install --upgrade pip
pip install yamllint
- name: Run yamllint
run: |
yamllint -c ./.config/.yamllint .
3 changes: 2 additions & 1 deletion services/crypto/secMgmt/features.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ features:
- id: CCC.SecMgmt.F04 # Secret Replication Policies
title: Secret Replication Policies
description: |
Allows configuration of secret replication policies to control where secrets are stored and replicated, supporting compliance with data residency requirements.
Allows configuration of secret replication policies to control where secrets are stored and replicated,
supporting compliance with data residency requirements.
- id: CCC.SecMgmt.F05 # Secure Secret Retrieval API
title: Secure Secret Retrieval API
Expand Down

0 comments on commit d4a71db

Please sign in to comment.