Skip to content

feat: add quality improvement implementations (items 1,2,3,7,8,9) #8

feat: add quality improvement implementations (items 1,2,3,7,8,9)

feat: add quality improvement implementations (items 1,2,3,7,8,9) #8

Workflow file for this run

name: Documentation Check
on:
push:
branches: [main]
paths:
- '**/*.md'
pull_request:
branches: [main]
paths:
- '**/*.md'
jobs:
link-check:
name: Check Markdown Links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Link Checker
uses: lycheeverse/lychee-action@v1
with:
args: >-
--verbose
--no-progress
--exclude-mail
--exclude 'https://github.com/Bizuayeu/Plugins-Weave/compare/*'
--exclude 'https://github.com/Bizuayeu/Plugins-Weave/releases/*'
'**/*.md'
fail: true
- name: Create Issue on Failure
if: failure()
uses: actions/github-script@v7
with:
script: |
const title = 'Documentation Link Check Failed';
const body = `The documentation link check has failed in workflow run [#${context.runNumber}](${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}).
Please review the broken links and fix them.`;
// Check if issue already exists
const issues = await github.rest.issues.listForRepo({
owner: context.repo.owner,
repo: context.repo.repo,
state: 'open',
labels: 'documentation'
});
const existingIssue = issues.data.find(issue => issue.title === title);
if (!existingIssue) {
await github.rest.issues.create({
owner: context.repo.owner,
repo: context.repo.repo,
title: title,
body: body,
labels: ['documentation', 'bug']
});
}
markdown-lint:
name: Lint Markdown Files
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: markdownlint-cli2-action
uses: DavidAnson/markdownlint-cli2-action@v16
with:
globs: '**/*.md'
fix: false
continue-on-error: true