learn.python/.github/workflows/curriculum-checks.yml at d4b34cabeea9ff049bb0990d7a1655a54b93c126 · travisjneuman/learn.python · 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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
name: Curriculum Checks

on:
  push:
    paths:
      - '**.md'
      - 'projects/**'
      - 'tools/**'
      - '.github/workflows/curriculum-checks.yml'
  pull_request:
    paths:
      - '**.md'
      - 'projects/**'
      - 'tools/**'
      - '.github/workflows/curriculum-checks.yml'
  workflow_dispatch:
    inputs:
      full_smoke:
        description: 'Run full smoke suite (all 165 projects)'
        required: false
        default: 'false'
  schedule:
    # Quarterly on Jan/Apr/Jul/Oct 1st at 06:00 UTC
    - cron: '0 6 1 1,4,7,10 *'

jobs:
  quick-checks:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Markdown link checks
        run: ./tools/check_markdown_links.sh

      - name: Root doc contract checks
        run: ./tools/check_root_doc_contract.sh

      - name: Level index contract checks
        run: ./tools/check_level_index_contract.sh

      - name: Project README contract checks
        run: ./tools/check_project_readme_contract.sh

      - name: Project python comment/docstring contract checks
        run: ./tools/check_project_python_comment_contract.sh

      - name: Portable path contract checks
        run: ./tools/check_portable_paths.sh

      - name: Elite track contract checks
        run: ./tools/check_elite_track_contract.sh

      - name: Project quick smoke checks
        run: ./projects/run_smoke_checks.sh

      - name: Elite quick smoke checks
        run: ./projects/run_elite_smoke_checks.sh

  full-smoke:
    if: github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && github.event.inputs.full_smoke == 'true')
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.12'

      - name: Full curriculum checks
        run: ./tools/run_all_curriculum_checks.sh --full