Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CI: Sphinx exec Haskell directive checks output against golden file or cache #66

Open
doyougnu opened this issue Jan 25, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request sphinx
Milestone

Comments

@doyougnu
Copy link
Collaborator

The sphinx extension we use to run haskell code should check the output of that code against a golden file to ensure that the book's code snippets build in the way we expect and to ensure output does not change across GHC/Cabal/Stack versions.

The code is in root/extensions/sphinx_exec_directive.py. We should have:

  • A setting that points to the golden file directory. This directory layout should follow the layout of the book.
  • A setting exposed to the user that disables this feature in conf.py. We want fast rebuilds while writing and checked builds on CI.
@doyougnu doyougnu added enhancement New feature or request sphinx labels Jan 25, 2023
@doyougnu doyougnu added this to the Phase 1 milestone Jan 25, 2023
@doyougnu doyougnu self-assigned this Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request sphinx
Projects
None yet
Development

No branches or pull requests

1 participant