Skip to content

docs: add VHS tape for bump command GIF #1878

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.

Sign up for GitHub

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

Open
HankyStyle wants to merge 2 commits into
base: master
Choose a base branch
from
+135 −1
Open

docs: add VHS tape for bump command GIF #1878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ee2831
docs: add VHS tape for bump command GIF
HankyStyle Feb 23, 2026
c1d571f
docs: replace bump GIF with VHS-generated version
HankyStyle Feb 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/commands/bump.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Bump version](../images/bump.gif)
![Bump version](../images/cli_interactive/bump.gif)

## About

Expand Down
Binary file removed docs/images/bump.gif
View file
Open in desktop
Binary file not shown.
134 changes: 134 additions & 0 deletions docs/images/bump.tape
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
Output cli_interactive/bump.gif

Require cz

# Use bash for cross-platform compatibility (macOS, Linux, Windows)
Set Shell bash

Set FontSize 16
Set Width 878
Set Height 568
Set Padding 20
Set TypingSpeed 50ms

Set Theme {
"name": "Commitizen",
"black": "#232628",
"red": "#fc4384",
"green": "#b3e33b",
"yellow": "#ffa727",
"blue": "#75dff2",
"magenta": "#ae89fe",
"cyan": "#708387",
"white": "#d5d5d0",
"brightBlack": "#626566",
"brightRed": "#ff7fac",
"brightGreen": "#c8ed71",
"brightYellow": "#ebdf86",
"brightBlue": "#75dff2",
"brightMagenta": "#ae89fe",
"brightCyan": "#b1c6ca",
"brightWhite": "#f9f9f4",
"background": "#1e1e2e",
"foreground": "#afafaf",
"cursor": "#c7c7c7"
}

# Hide initial shell prompt
Hide

# Wait for terminal to be ready
Sleep 1s

# Set a clean, simple prompt (while hidden)
Type "PS1='$ '"
Enter
Sleep 300ms

# Create a clean temporary directory for recording
Type "rm -rf /tmp/commitizen-example && mkdir -p /tmp/commitizen-example && cd /tmp/commitizen-example"
Enter
Sleep 500ms

# Initialize git repository
Type "git init"
Enter
Type "git config user.email 'you@example.com'"
Enter
Type "git config user.name 'Your Name'"
Enter
Sleep 500ms

# Initialize commitizen config with version 0.0.1 and changelog enabled
Type `cat > pyproject.toml << 'EOF'`
Enter
Sleep 100ms
Type `[tool.commitizen]`
Enter
Sleep 100ms
Type `version = "0.0.1"`
Enter
Sleep 100ms
Type `update_changelog_on_bump = true`
Enter
Sleep 100ms
Type "EOF"
Enter
Sleep 300ms

# Create initial commit (no tag, so cz bump will ask "Is this the first tag created?")
Type "git add pyproject.toml"
Enter
Sleep 300ms

Type "git commit -m 'chore: initial commit'"
Enter
Sleep 500ms

# Create a feat commit that will trigger a MINOR bump (0.0.1 -> 0.1.0)
Type "echo 'new feature' > feature.py"
Enter
Sleep 300ms

Type "git add feature.py"
Enter
Sleep 300ms

Type "git commit -m 'feat: add awesome new feature'"
Enter
Sleep 500ms
Comment on lines +48 to +99
Copy link
Collaborator

@bearomorphism bearomorphism Feb 23, 2026

Choose a reason for hiding this comment

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

I'm not sure whether we should do the setup in this tape file. It is probably cleaner if we can setup the environment for recording in a bash script

Copy link
Contributor Author

@HankyStyle HankyStyle Feb 23, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

Do you mean creating setup scripts (e.g. setup.sh) and let this tape source it in the beginning Hide section?

setup.sh


#!/bin/bash
set -e

git init
git config user.email 'you@example.com'
git config user.name 'Your Name'

cat > pyproject.toml << 'EOF'
[tool.commitizen]
version = "0.0.1"
update_changelog_on_bump = true
EOF

git add pyproject.toml
git commit -m 'chore: initial commit'

# Create a feat commit to trigger a MINOR bump (0.0.1 -> 0.1.0)
echo 'new feature' > feature.py
git add feature.py
git commit -m 'feat: add awesome new feature'

bump.tape

Hide
Type "source setup.sh && cd /tmp/commitizen-example" <-- source bash script
Enter
Sleep 2s
Type "clear"
Enter

Show
# Step 1: Show current version
Type "cz version --project"
Sleep 500ms
Enter
Sleep 1s

# Step 2: Run cz bump (no existing tag, will prompt for first tag)
Type "cz bump"
Sleep 500ms
Enter
......

Maybe we can set up the environment in docspublish.yml instead?


# Clear the screen to start fresh
Type "clear"
Enter
Sleep 500ms

# Show commands from here
Show

# Step 1: Show current version
Type "cz version --project"
Sleep 500ms
Enter
Sleep 1s

# Step 2: Run cz bump (no existing tag, will prompt for first tag)
Type "cz bump"
Sleep 500ms
Enter

# Wait for the "Is this the first tag created?" prompt
Sleep 2s

# Answer Yes to "Is this the first tag created?" (default is Yes, just press Enter)
Enter
Sleep 3s

# Step 3: Show new version after bump
Type "cz version --project"
Sleep 500ms
Enter
Sleep 1s

# Wait for final output
Sleep 3s
Binary file added docs/images/cli_interactive/bump.gif
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.