adaptive-sensor-testing/.github/workflows/ci.yml at main · adaptive-interfaces/adaptive-sensor-testing · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
# ============================================================
# .github/workflows/ci.yml (Continuous Integration)
# ============================================================
#
# WHY-FILE: Validate repository hygiene, python, and documentation builds.
# REQ: CI MUST NOT introduce arbitrary rules that are not reproducible locally.
# OBS: CI validates only; it should not edit files or deploy docs.

name: CI

# WHY: Validate on PRs and pushes.
# OBS: This workflow validates only.

on:
  push:
    branches: [main] # WHY: Run when pushing to main branch.
  pull_request:
    branches: [main] # WHY: Run on pull requests targeting main branch.
  workflow_dispatch: # WHY: Allow manual triggering from Actions tab.

permissions: # WHY: Use least privileges required.
  contents: read

env:
  PYTHONUNBUFFERED: "1" # WHY: Real-time logging.
  PYTHONIOENCODING: "utf-8" # WHY: Ensure UTF-8 encoding for international characters.

jobs:
  ci:
    name: CI
    runs-on: ubuntu-latest # WHY: Linux environment is standard for CI.
    timeout-minutes: 10 # WHY: Prevent hanging jobs; markdown lint completes well under this.

    steps:
      # ============================================================
      # ASSEMBLE: Get code
      # ============================================================

      - name: A1) Checkout repository code
        # WHY: Needed to access files for checks.
        uses: actions/checkout@v6

      # ============================================================
      # BASIC CHECKS: Markdown
      # ============================================================

      - name: B1) Lint markdown files
        # WHY: Enforce consistent formatting in normative schema docs and README.
        uses: DavidAnson/markdownlint-cli2-action@v23
        with:
          globs: "**/*.md"

      - name: B2) Skill check
        # WHY: Validate that SKILL.md is well-formed and meets criteria for agent use.
        uses: moonrunnerkc/skillcheck@v0.2.0
        with:
          path: SKILL.md
          min-desc-score: 60
          skip-dirname-check: true  # WHY: CI clones to temp paths