Skip to content

1.3.0

Choose a tag to compare

@lars-derichter lars-derichter released this 10 Sep 20:23
· 43 commits to main since this release
42933dc
  • The theme comment in the shipped course.config.yml pointed at
    docs/customization.md; the guide is docs/customisation.md. A course made
    from an earlier release keeps its own copy of the file, so fix the path there
    by hand if it bothers you.

  • Course: Check in the command palette runs npx course check in the shared
    terminal, the way Course: Validate does. Palette only, like Course:
    Build Glossary
    : no entry in the Course Manager tree or its menus.
    check-links has no entry of its own, since Check runs it.

  • npx course check runs every pre-ship check in one go and exits non-zero
    naming the ones that failed: validate; build-glossary --check when the
    course keeps a glossary at the default path, skipped and said so when it does
    not, since the glossary command fails without one; check-links; and every
    entry of checks.extra in course.config.yml. Each runs as its own process,
    so one failure does not stop the rest. npm run hooks:install installs it as
    a git pre-push hook, and .github/workflows/course-checks.yml runs it in
    place of validate alone, so a course's CI now covers glossary freshness, the
    plain link check and the course's own extras as well.

  • npx course check-links reports every relative markdown or image link whose
    target does not exist on disk, under the folders checks.links.roots names
    (course alone by default) or a repeated --root. validate resolves the
    links between the items it scans and nothing else, so course/index.md,
    course/LICENSE.md, a folder nested deeper than a module takes and any
    markdown kept outside course/ went unchecked; this is the plain filesystem
    check beside it. Code blocks and inline code are ignored, external URLs and
    site-absolute paths are left alone, and the run lists every broken link and
    exits non-zero when there is one.

  • course.config.yml takes a checks: section for the pre-ship checks.
    links.roots lists the folders check-links scans for broken relative links,
    course alone unless a course says otherwise; extra lists the subcommands
    check runs after its built-in list, so a course that registered a command of
    its own (a games build, say) has it gated by the same command and the same
    pre-push hook without patching the tooling after every update. A value of the
    wrong shape warns and falls back, entry by entry where it can, like every
    other key in the file.