Skip to content

Conversation

chrisjkuch
Copy link
Contributor

When we added testing frameworks to the option set (#447) we did not update the terminal animation inputs so the last one was missing. This made the build fail because we assert that all options are present in the generated animation.

To prevent us missing this in the future, I've added building the docs to the tests workflow so that we'll fail if the docs do not properly generate.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request fixes an issue with the terminal animation generation used in the docs build by updating the input options and ensuring the docs build is executed as part of the tests workflow.

  • Added a new tuple for the testing framework input in the terminal animation generation script.
  • Updated the tests workflow by removing docs exclusion and adding a documentation build step.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/scripts/generate-termynal.py Adds the missing testing framework input for terminal animation.
.github/workflows/tests.yml Updates workflow configuration to trigger docs build on changes.
Comments suppressed due to low confidence (1)

.github/workflows/tests.yml:43

  • Verify that the 'make docs' command returns a failing status code in case of documentation build errors, ensuring that the docs build step properly enforces build integrity.
- name: Build documentation

Copy link
Member

@pjbull pjbull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change LGTM, pending resolving the failures (which look like they are happening on main too. Looks like some resolution of dependency problem for the particular combination of packages in one of the configs on Windows.)

@pjbull pjbull temporarily deployed to cjk-docs-tests - Cookiecutter Data Science PR #451 June 8, 2025 18:24 — with Render Destroyed
@chrisjkuch chrisjkuch merged commit b68cad8 into master Jun 9, 2025
63 of 80 checks passed
@chrisjkuch chrisjkuch deleted the cjk-docs-tests branch June 9, 2025 09:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants