Skip to content

Comments

docs: add VHS tape for bump command GIF#1878

Merged
bearomorphism merged 2 commits intocommitizen-tools:masterfrom
HankyStyle:docs/add-bump-tape
Feb 24, 2026
Merged

docs: add VHS tape for bump command GIF#1878
bearomorphism merged 2 commits intocommitizen-tools:masterfrom
HankyStyle:docs/add-bump-tape

Conversation

@HankyStyle
Copy link
Contributor

@HankyStyle HankyStyle commented Feb 23, 2026

Description

Use VHS tape to generate bump.gif

Once this PR is merged, the existing CI workflow (docspublish.yml) will automatically regenerate bump.gif on every push to master if the bump command has been changed.

Changes

  • Add docs/images/bump.tape for recording cz bump demo
  • Remove docs/images/bump.gif and replace it with docs/images/cli_interactive/bump.gif
  • Update docs/commands/bump.md gif image path to new location

Checklist

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

  • Yes
    Gemini 3.0 + Antigravity

Code Changes

  • Run uv run poe all locally to ensure this change passes linter check and tests
  • Update the documentation for the changes

Documentation Changes

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

Expected Behavior

The cz bump documentation page displays a VHS-generated GIF that demonstrates:

  1. cz version --project → shows 0.0.1
  2. cz bump → prompts for first tag, bumps to 0.1.0
  3. cz version --project → shows 0.1.0

Steps to Test This Pull Request

  1. Run cd docs/images && vhs bump.tape
  2. Verify cli_interactive/bump.gif is generated
  3. Run uv run poe doc and check the bump command page

@bearomorphism bearomorphism merged commit 0b95c76 into commitizen-tools:master Feb 24, 2026
18 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.

2 participants