Astrona content validate

astrona content validate¶

Validate a lab or section directory (for teachers and authors)

Synopsis¶

Validate a training repository (Astrona Training Series - ATS, 'ats': its astrona.yaml — readings, labs, playgrounds and quiz question banks, checked the way astrona.io reads them) or a course section directory (Astrona Training Path - ATP, 'atp'). source is either a local folder path (the raw content files) or a git repository URL (https://, git@host:, ssh://, or a .git suffix), optionally pinned to a branch or tag with --git-ref.

astrona content validate <type> <source> [flags]

Examples¶

  astrona content validate ats ./ATS014
  astrona content validate ats https://github.com/astrona-io/ATS014.git --git-ref main
  astrona content validate atp ./paths/kubernetes-networking
  astrona content validate atp https://github.com/astrona-io/kubernetes-networking-atp.git --git-ref v1.2.0
  astrona content validate atp git@github.com:astrona-io/kubernetes-networking-atp.git --git-ref main

Options¶

      --git-ref string   Git branch, tag, or commit to check out (only used when source is a git URL)
  -h, --help             help for validate

Options inherited from parent commands¶

      --accept-terms      Accept this CLI's usage terms and data-loss risk notice; required on each operational CI command (read: astrona terms)
  -c, --config string     Path or URL to the lab config directory (with --git: a subdirectory within the cloned repo) (default ".")
  -f, --file string       Configuration file name override (default "config.yaml")
      --git string        Git repository URL to clone/pull (https://, git@host:, or ssh://) — --config then selects a subdirectory within it
      --headless          Disable the terminal UI and CLI prompts; run/reset skip login reminders and new account sessions
      --install-version   If the lab needs another astrona release (astronaVersion) that isn't installed, install it without asking — for CI
      --trust             Approve running a remote (--git / URL) lab without asking — for CI; review the lab first
      --update-check      Check for new CLI releases (disabled in CI, without a terminal, or by ASTRONA_NO_UPDATE_CHECK) (default true)
      --verbose           Stream the full output of every underlying command instead of the compact step view