Skip to content

Commit 2941133

Browse files
committed
Replace Workflows
1. The current workflows are not suited for the repo use case, and are replaced with better CI checks. 2. The Repository uses prettier for formatting, so remove the conflicting markdownlint check. 3. Also it's will contain many techincal term so it's not benefitted with spell-check too. 4. Instead introduce a prettier based format check, and a broken link checker, which will be more useful for the project.
1 parent 880c7f8 commit 2941133

File tree

4 files changed

+48
-50
lines changed

4 files changed

+48
-50
lines changed

.github/workflows/link-check.yml

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Link Checker
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "**/*.md"
7+
8+
jobs:
9+
link-checker:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v3
15+
16+
- name: Run lychee link checker
17+
uses: lycheeverse/lychee-action@v1
18+
with:
19+
args: --exclude-local

.github/workflows/markdown-lint.yml

-26
This file was deleted.

.github/workflows/prettier-check.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Prettier Check
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- "**/*.md"
7+
8+
jobs:
9+
prettier-check:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v3
15+
16+
- name: Set up Node.js
17+
uses: actions/setup-node@v3
18+
with:
19+
node-version: '16' # or the version your project uses
20+
21+
- name: Install dependencies
22+
run: npm ci
23+
24+
- name: Run Prettier check
25+
run: npx prettier --check "**/*.md"
26+
27+
- name: Report formatting issues
28+
if: failure()
29+
run: echo "Some Markdown files are not properly formatted. Please run Prettier locally and commit the changes."

.github/workflows/spell-check.yml

-24
This file was deleted.

0 commit comments

Comments
 (0)