Skip to content

Ci/markdownlint - #5

Open
iplaycomputer wants to merge 2 commits into
mainfrom
ci/markdownlint
Open

Ci/markdownlint#5
iplaycomputer wants to merge 2 commits into
mainfrom
ci/markdownlint

Conversation

@iplaycomputer

@iplaycomputer iplaycomputer commented Sep 29, 2025

Copy link
Copy Markdown
Owner

Summary

Add a minimal GitHub Actions workflow to run markdownlint on every PR and on pushes to main, enforcing our “strict but low-churn” Markdown rules.

Linked Artifacts (relative paths)

  • Ticket(s): n/a
  • KB: n/a
  • Lab: n/a
  • Scenario: n/a

Checklists

  • Content
    • Uses the correct template (copied from 000.*-template.md)
    • Clear, reproducible steps and plain language
    • Relative links resolve inside the repo
    • Avoid duplication across modules (KB = productized steps; Lab = full commands + Verification; Scenario = flow/success, links only)
    • Deep link to sections where applicable (KB → #resolution-steps, Lab → #verification)
  • Metadata
    • Owner set; Last Reviewed and Next Review Due (KB/Lab)
    • Escalation Path filled (Ticket)
    • Metrics block added if useful (see docs/METRICS.md)
  • Quality
    • Verification steps included (expected outputs / pass-fail)
    • Anchors exist and resolve (KB “Resolution Steps”, Lab “Verification”)
    • Scenario (if present) ties Ticket → KB → Lab and defines success criteria

Labs (if included)

  • Dedicated “Verification” section with expected outputs
  • Images pinned if using containers; HTTP services include a simple healthcheck when applicable
  • Assets stored under labs/<lab>/assets/

KBs (if included)

  • Brief (1–2 lines) verification; link to related Lab for full commands

Scenarios (if included)

  • Uses deep links to KB “Resolution Steps” and Lab “Verification” (no step duplication)

Notes

  • Workflow file: .github/workflows/markdownlint.yml
  • Uses: DavidAnson/markdownlint-cli2-action@v17
  • Reads configs: .markdownlint-cli2.jsonc (globs/ignores) and .markdownlint.jsonc (rules)
  • Ignores (per current policy): README.md and .github/**/*.md
  • Scope: CI-only; no content changes
  • Risk/Impact: very low; CI-only addition that uses existing repo lint config

How to Verify (for reviewers)

  • Ensure the new markdownlint check runs and passes on this PR
  • Confirm the workflow file renders correctly (no duplicate YAML blocks)
  • Optional: run markdownlint locally and confirm behavior matches CI (same configs and ignore patterns)

@iplaycomputer iplaycomputer self-assigned this Sep 29, 2025

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a GitHub Actions workflow to enforce Markdown linting standards on pull requests and pushes to main. The workflow uses markdownlint-cli2-action to automatically check Markdown files against project-defined rules.

  • Updates the job name from "lint" to "markdownlint" for clarity
  • Upgrades markdownlint-cli2-action from v16 to v17
  • Simplifies configuration by relying on repository config files instead of inline globs

@iplaycomputer
iplaycomputer enabled auto-merge (squash) September 30, 2025 20:49

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@iplaycomputer
iplaycomputer enabled auto-merge (squash) September 30, 2025 22:12
@iplaycomputer
iplaycomputer enabled auto-merge (squash) September 30, 2025 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants