Skip to content

Automate testing and publishing #41

@MaybeJustJames

Description

@MaybeJustJames

Store a single source format from which the following can be generated:

  • Jupyter Notebooks as they currently exist (with room for students to fill in exercise solutions) and solved notebooks
  • Pure python code extracted from code cells that can be tested in CI (including expected failures/exceptions)
  • Possibly quiz slides
  • Possibly markdown for the training website

There are 2 motivations for this:

  1. Reduce the risk of mistakes in the course material.
  2. This course should encourage and exemplify good software engineering practice. Testing is an important part of software engineering practice. Therefore this course should employ testing, even if it is invisible to students.

A possible solution could look like the PureScript Book which is checked in CI. It is distributed with NoPeeking solutions that can be tested (allowing problems and exercises to be reviewed).

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions