Skip to content

Refactor: Doc(images) VHS tapes with shared snippets#1906

Merged
bearomorphism merged 3 commits intocommitizen-tools:masterfrom
ttw225:refactor/doc_gif
Apr 15, 2026
Merged

Refactor: Doc(images) VHS tapes with shared snippets#1906
bearomorphism merged 3 commits intocommitizen-tools:masterfrom
ttw225:refactor/doc_gif

Conversation

@ttw225
Copy link
Copy Markdown
Contributor

@ttw225 ttw225 commented Mar 20, 2026

Description

Refactor CLI documentation GIF tapes to reduce duplication and keep recording settings consistent.

  • Add shared VHS snippets under docs/images/shared/ (base.tape for shell/theme/typing setup, git_init.tape, cleanup.tape).
  • Update bump.tape, commit.tape, init.tape, shortcut_custom.tape, and shortcut_default.tape to Source those snippets instead of repeating the same preamble.
  • Remove unused docs/images/bump.yml and docs/images/commit.yml.

Checklist

Was generative AI tooling used to co-author this PR?

  • Yes (please specify the tool below)

Generated-with: [Cursor] following the guidelines

Code Changes

  • Add test cases to all the changes you introduce
  • Run uv run poe all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run uv run poe doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external)

Expected Behavior

  • Regenerating CLI GIFs with VHS continues to work
  • Tapes stay shorter and easier to maintain
  • Removed YAML files are not referenced by the doc build or tape workflow

Steps to Test This Pull Request

uv run poe doc:screenshots

Additional Context

Copy link
Copy Markdown
Collaborator

@bearomorphism bearomorphism left a comment

Choose a reason for hiding this comment

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

LGTM. Sorry for the delayed review

Copy link
Copy Markdown

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

Refactors the VHS “tape” scripts used to generate CLI documentation GIFs by extracting common setup/teardown into shared snippets, reducing duplication and keeping recording settings consistent.

Changes:

  • Introduces shared VHS snippets under docs/images/shared/ for common terminal setup, git initialization, and cleanup.
  • Updates existing .tape files to Source the shared snippets instead of duplicating preambles.
  • Removes legacy/unused YAML recording artifacts (bump.yml, commit.yml).

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/images/shared/base.tape New shared snippet for consistent shell/theme/terminal + temp dir setup.
docs/images/shared/git_init.tape New shared snippet for git repo initialization and user config.
docs/images/shared/cleanup.tape New shared snippet to hide and clean the temp working directory.
docs/images/bump.tape Refactored to source shared setup/git init/cleanup snippets.
docs/images/commit.tape Refactored to source shared setup/git init/cleanup snippets.
docs/images/init.tape Refactored to source shared setup + cleanup snippets.
docs/images/shortcut_default.tape Refactored to source shared setup/git init/cleanup snippets.
docs/images/shortcut_custom.tape Refactored to source shared setup/git init/cleanup snippets.
docs/images/bump.yml Removed unused legacy recording config/artifact.
docs/images/commit.yml Removed unused legacy recording config/artifact.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bearomorphism bearomorphism merged commit abff812 into commitizen-tools:master Apr 15, 2026
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants