Skip to content

Commit fe94d88

Browse files
committed
chore: add org reusable CI workflows for docs
Repo had zero CI before this. Adds: - ci.yml calling markdown-check + security-scan from mca-nitw/.github - .markdownlint.yml: relaxed config for academic notes (allows long lines, inline HTML, math fences without language tag) - renovate.json reduced to extending shared preset The markdown-check reusable runs markdownlint and lychee dead-link check (continue-on-error so a single broken external URL doesnt block PRs).
1 parent ba1e9b6 commit fe94d88

3 files changed

Lines changed: 50 additions & 38 deletions

File tree

.github/workflows/ci.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
docs:
11+
name: Documentation Checks
12+
uses: mca-nitw/.github/.github/workflows/markdown-check.yml@main
13+
with:
14+
glob: "**/*.md"
15+
check-links: true
16+
17+
security:
18+
name: Security Scan
19+
uses: mca-nitw/.github/.github/workflows/security-scan.yml@main
20+
permissions:
21+
contents: read
22+
security-events: write

.markdownlint.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Markdownlint config — relaxed for academic notes which contain
2+
# heavy formula/code/list nesting and may not need strict prose linting.
3+
4+
default: true
5+
6+
# Allow long lines (notes often quote long URLs / formulas)
7+
MD013: false
8+
9+
# Allow inline HTML (used for tables, embedded SVG/images)
10+
MD033: false
11+
12+
# Don't require unique top-level headings (per-section notes can repeat)
13+
MD025: false
14+
15+
# Allow duplicate heading text (common for "Examples" / "Summary" sections)
16+
MD024:
17+
siblings_only: true
18+
19+
# Don't require trailing newline (auto-fixed elsewhere)
20+
MD047: false
21+
22+
# Trailing punctuation in headings is fine for academic notes
23+
MD026: false
24+
25+
# Allow no language tag on fenced code (math/pseudocode often)
26+
MD040: false

renovate.json

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,4 @@
11
{
2-
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3-
"extends": ["config:recommended", ":dependencyDashboard"],
4-
"timezone": "Asia/Kolkata",
5-
"schedule": ["before 3am on monday"],
6-
"prHourlyLimit": 2,
7-
"prConcurrentLimit": 3,
8-
"rangeStrategy": "replace",
9-
"packageRules": [
10-
{
11-
"matchUpdateTypes": ["minor", "patch", "pin", "digest"],
12-
"automerge": true,
13-
"automergeType": "pr",
14-
"automergeStrategy": "squash",
15-
"groupName": "non-major weekly",
16-
"labels": ["dependencies", "auto-merge"]
17-
},
18-
{
19-
"matchUpdateTypes": ["major"],
20-
"groupName": "major updates",
21-
"labels": ["dependencies", "major"],
22-
"dependencyDashboardApproval": true
23-
},
24-
{
25-
"matchDatasources": ["docker"],
26-
"groupName": "docker",
27-
"schedule": ["before 3am on monday"]
28-
},
29-
{
30-
"matchCategories": ["lock-file-maintenance"],
31-
"schedule": ["before 3am on monday"],
32-
"automerge": true
33-
}
34-
],
35-
"vulnerabilityAlerts": {
36-
"enabled": true,
37-
"labels": ["security"],
38-
"schedule": ["at any time"]
39-
}
2+
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
3+
"extends": ["github>mca-nitw/.github"]
404
}

0 commit comments

Comments
 (0)